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

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

== Synopsis

Declared in `<bdlde_base64decoder.h>`

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

== Type Aliases

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


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/Base64Decoder/2constructor-028.adoc[`Base64Decoder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlde/Base64Decoder/2destructor.adoc[`~Base64Decoder`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlde/Base64Decoder/alphabet-0e.adoc[`alphabet`] 
| Return the alphabet supplied at construction of this object.
| xref:BloombergLP/bdlde/Base64Decoder/convert-05.adoc[`convert`] 
| `convert` overloads
| xref:BloombergLP/bdlde/Base64Decoder/endConvert-0bf.adoc[`endConvert`] 
| `endConvert` overloads
| xref:BloombergLP/bdlde/Base64Decoder/ignoreMode-00.adoc[`ignoreMode`] 
| Return the `ignoreMode` state of this decoder.
| xref:BloombergLP/bdlde/Base64Decoder/isAcceptable.adoc[`isAcceptable`] 
| Return `true` if the input read so far is considered syntactically complete, and `false` otherwise. Note that the number of relevant input characters must be divisible by 4.
| xref:BloombergLP/bdlde/Base64Decoder/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/Base64Decoder/isError.adoc[`isError`] 
| Return `true` if there is no possibility of achieving an "acceptable" result, and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Decoder/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/Base64Decoder/isMaximal.adoc[`isMaximal`] 
| Return `true` if the current input is acceptable and any additional input (other than `endConvert`) would be an error, and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Decoder/isPadded.adoc[`isPadded`] 
| Return `true` if this object is configured for padded input and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Decoder/isUnrecognizedAnError.adoc[`isUnrecognizedAnError`] 
| Return `true` if this mechanism is currently configured to report an error when an unrecognized character (i.e., a character other than one of the 64 "numeric" base‐64 characters, `=`, or whitespace) is encountered, and `false` otherwise.
| xref:BloombergLP/bdlde/Base64Decoder/options.adoc[`options`] 
| Return a `Base64DecoderOptions` object representing the configuration of this decoder.
| xref:BloombergLP/bdlde/Base64Decoder/outputLength.adoc[`outputLength`] 
| Return the total length of the output emitted thus far.
| xref:BloombergLP/bdlde/Base64Decoder/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/Base64Decoder/maxDecodedLength.adoc[`maxDecodedLength`] 
| Return the maximum number of decoded bytes that could result from an input byte sequence of the specified `inputLength` provided to the `convert` and `endConvert` methods of this decoder. The behavior is undefined unless `0 <= inputLength`. Note that the result is independent of which options are provided to the decoder.
|===


== Static Data Members

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



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