The Base64 encoder class.
More...
#include <murl_util_encoding_base64.h>
The Base64 encoder class.
◆ Base64Encoder() [1/2]
Murl::Util::Base64Encoder::Base64Encoder |
( |
| ) |
|
The default constructor.
Line formatting is disabled.
◆ Base64Encoder() [2/2]
Murl::Util::Base64Encoder::Base64Encoder |
( |
UInt32 |
charsPerLine | ) |
|
Constructor enabling line formatting.
- Parameters
-
charsPerLine | The maximum characters per line. |
◆ GetEncodedLength()
UInt64 Murl::Util::Base64Encoder::GetEncodedLength |
( |
UInt64 |
byteSizeIn | ) |
const |
Compute the Base64 encoded length.
- Parameters
-
byteSizeIn | The number of source bytes. |
- Returns
- The number of bytes required for Base64 encoding.
◆ Encode()
UInt64 Murl::Util::Base64Encoder::Encode |
( |
const void * |
dataIn, |
|
|
UInt64 |
byteSizeIn, |
|
|
void * |
dataOut, |
|
|
UInt64 |
byteSizeOut, |
|
|
Bool |
encodeEnd = true |
|
) |
| |
Encode a memory block to Base64 characters.
Encoding can be called sequential for divided source blocks.
- Parameters
-
dataIn | Pointer to the source memory block. |
byteSizeIn | The byte size of the source memory block. |
dataOut | Pointer to the destination memory block. |
byteSizeOut | The byte size of the destination memory block. |
encodeEnd | If true the padding characters are encoded automatically at the end of the block. Set to false if sequential encoding is required and call EncodeEnd method finally. |
- Returns
- The number of bytes written into destination.
◆ EncodeEnd()
UInt64 Murl::Util::Base64Encoder::EncodeEnd |
( |
void * |
dataOut, |
|
|
UInt64 |
byteSizeOut |
|
) |
| |
Encode the Base64 end padding characters.
This method is required if the encodeEnd parameter from the Encode method is set to false.
- Parameters
-
dataOut | Pointer to the destination memory block. |
byteSizeOut | The byte size of the destination memory block. |
- Returns
- The number of bytes written into destination.
◆ EncodeValue()
Char Murl::Util::Base64Encoder::EncodeValue |
( |
Char |
value | ) |
const |
Encode a 6-bit value to the Base64 character.
- Parameters
-
value | The 6-bit value to encode. |
- Returns
- The corresponding Base64 character or '=' if the value is out of range.
◆ mLineCount
UInt32 Murl::Util::Base64Encoder::mLineCount |
|
protected |
The current line character position.
◆ mCharsPerLine
UInt32 Murl::Util::Base64Encoder::mCharsPerLine |
|
protected |
The maximum characters per line.
The documentation for this class was generated from the following file:
- murl_util_encoding_base64.h