This class implements a mechanism capable of converting data of arbitrary length to its corresponding Base64 representation.

Synopsis

Declared in <bdlde_base64encoder.h>

class Base64Encoder;

Type Aliases

Name

Description

Alphabet

Alias for Base64Alphabet::Enum.

Member Functions

Name

Description

Base64Encoder [constructor]

Constructors

~Base64Encoder [destructor]

Destroy this object.

alphabet

Return the alphabet supplied at construction of this object.

convert

convert overloads

endConvert

endConvert overloads

isAcceptable

Return true if the input read so far is considered syntactically complete and all resulting output has been emitted to out, and false otherwise. Note that endConvert must be called if the total length of all data processed is not divisible by 3.

isDone

Return true if the current input is acceptable and any additional input (including endConvert) would be an error, and false otherwise. Note that if this decoder isDone then all resulting output has been emitted to out.

isError

Return true if there is no possibility of achieving an "acceptable" result, and false otherwise.

isInitialState

Return true if this instance is in the initial state (i.e., as if no input had been consumed), and false otherwise.

isPadded

Return true if padding by = characters was specified at construction of this object.

maxLineLength

Return the currently installed value for the maximum line length.

options

Return an options object reflecting the options this object was configured with.

outputLength

Return the total length of the output emitted thus far (including soft line breaks where appropriate).

resetState

Reset this instance to its initial state (i.e., as if no input had been consumed).

Static Member Functions

Name

Description

encodedLength

encodedLength overloads

encodedLines

encodedLines overloads

Static Data Members

Name

Description

e_BASIC

Basic Base64 alphabet.

e_URL

URL‐safe Base64 alphabet.

Created with MrDocs