[#BloombergLP-bdlde-Base64Encoder]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlde.adoc[bdlde]::Base64Encoder
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `<bdlde_base64encoder.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Base64Encoder;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64Encoder/Alphabet-0b.adoc[`Alphabet`] 
| Alias for `Base64Alphabet::Enum`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64Encoder/2constructor-05.adoc[`Base64Encoder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlde/Base64Encoder/2destructor.adoc[`~Base64Encoder`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlde/Base64Encoder/alphabet-02.adoc[`alphabet`] 
| Return the alphabet supplied at construction of this object.
| xref:BloombergLP/bdlde/Base64Encoder/convert-06.adoc[`convert`] 
| `convert` overloads
| xref:BloombergLP/bdlde/Base64Encoder/endConvert-0b.adoc[`endConvert`] 
| `endConvert` overloads
| xref:BloombergLP/bdlde/Base64Encoder/isAcceptable.adoc[`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.
| xref:BloombergLP/bdlde/Base64Encoder/isDone.adoc[`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`.
| xref:BloombergLP/bdlde/Base64Encoder/isError.adoc[`isError`] 
| Return `true` if there is no possibility of achieving an "acceptable" result, and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Encoder/isInitialState.adoc[`isInitialState`] 
| Return `true` if this instance is in the initial state (i.e., as if no input had been consumed), and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Encoder/isPadded.adoc[`isPadded`] 
| Return true if padding by `=` characters was specified at construction of this object.
| xref:BloombergLP/bdlde/Base64Encoder/maxLineLength.adoc[`maxLineLength`] 
| Return the currently installed value for the maximum line length.
| xref:BloombergLP/bdlde/Base64Encoder/options.adoc[`options`] 
| Return an `options` object reflecting the options this object was configured with.
| xref:BloombergLP/bdlde/Base64Encoder/outputLength.adoc[`outputLength`] 
| Return the total length of the output emitted thus far (including soft line breaks where appropriate).
| xref:BloombergLP/bdlde/Base64Encoder/resetState.adoc[`resetState`] 
| Reset this instance to its initial state (i.e., as if no input had been consumed).
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64Encoder/encodedLength-07.adoc[`encodedLength`] 
| `encodedLength` overloads
| xref:BloombergLP/bdlde/Base64Encoder/encodedLines-0e.adoc[`encodedLines`] 
| `encodedLines` overloads
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64Encoder/e_BASIC.adoc[`e_BASIC`] 
| Basic Base64 alphabet.
| xref:BloombergLP/bdlde/Base64Encoder/e_URL.adoc[`e_URL`] 
| URL‐safe Base64 alphabet.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#