github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs: 'base 64' => Base64 (#2327)

Browse Source 
Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
This commit is contained in:
Anton Kolesnyk 2021-05-19 18:08:14 +00:00 committed by GitHub
parent 7b3f5d3c96
commit dcb2506862
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sdk/core/azure-core/inc/azure/core/base64.hpp
View File

@ -4,7 +4,7 @@
/**
* @file
* @brief Utility functions to help convert between binary data and UTF-8 encoded text that is
* represented in base 64.
* represented in Base64.
*/
#pragma once
@ -16,7 +16,7 @@ namespace Azure { namespace Core {
/**
* @brief Used to convert one form of data into another, for example encoding binary data into
* base 64 text.
* Base64 text.
*/
class Convert final {
private:
@ -25,17 +25,17 @@ namespace Azure { namespace Core {
public:
/**
* @brief Encodes the vector of binary data into UTF-8 encoded text represented as base 64.
* @brief Encodes the vector of binary data into UTF-8 encoded text represented as Base64.
*
* @param data The input vector that contains binary data that needs to be encoded.
* @return The UTF-8 encoded text in base 64.
* @return The UTF-8 encoded text in Base64.
*/
static std::string Base64Encode(const std::vector<uint8_t>& data);
/**
* @brief Decodes the UTF-8 encoded text represented as base 64 into binary data.
* @brief Decodes the UTF-8 encoded text represented as Base64 into binary data.
*
* @param text The input UTF-8 encoded text in base 64 that needs to be decoded.
* @param text The input UTF-8 encoded text in Base64 that needs to be decoded.
* @return The decoded binary data.
*/
static std::vector<uint8_t> Base64Decode(const std::string& text);