![]() |
Murl Engine API
Version 2024.1
|
The Base64 encoder class. More...
#include <murl_util_encoding_base64.h>
The Base64 encoder class.
Public Member Functions | |
Base64Encoder () | |
The default constructor. More... | |
Base64Encoder (UInt32 charsPerLine) | |
Constructor enabling line formatting. More... | |
UInt64 | GetEncodedLength (UInt64 byteSizeIn) const |
Compute the Base64 encoded length. More... | |
UInt64 | Encode (const void *dataIn, UInt64 byteSizeIn, void *dataOut, UInt64 byteSizeOut, Bool encodeEnd=true) |
Encode a memory block to Base64 characters. More... | |
UInt64 | EncodeEnd (void *dataOut, UInt64 byteSizeOut) const |
Encode the Base64 end padding characters. More... | |
Char | EncodeValue (Char value) const |
Encode a 6-bit value to the Base64 character. More... | |
Protected Attributes | |
UInt32 | mLineCount |
The current line character position. | |
UInt32 | mCharsPerLine |
The maximum characters per line. | |
![]() | |
Step | mStep |
The current state. | |
Char | mChar |
The current character. | |
Additional Inherited Members | |
![]() | |
enum | Step { STEP_A , STEP_B , STEP_C , STEP_D } |
State enumeration. More... | |
![]() | |
Base64State () | |
The default constructor. | |
Murl::Util::Base64Encoder::Base64Encoder | ( | ) |
The default constructor.
Line formatting is disabled.
Murl::Util::Base64Encoder::Base64Encoder | ( | UInt32 | charsPerLine | ) |
Constructor enabling line formatting.
charsPerLine | The maximum characters per line. |
Compute the Base64 encoded length.
byteSizeIn | The number of source bytes. |
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.
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. |
Encode the Base64 end padding characters.
This method is required if the encodeEnd parameter from the Encode method is set to false.
dataOut | Pointer to the destination memory block. |
byteSizeOut | The byte size of the destination memory block. |
Encode a 6-bit value to the Base64 character.
value | The 6-bit value to encode. |