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

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

== Synopsis

Declared in `<bdlde_hexencoder.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/HexEncoder/2constructor.adoc[`HexEncoder`]         [.small]#[constructor]#
| Create a Hex encoder in the initial state.
| xref:BloombergLP/bdlde/HexEncoder/convert-06.adoc[`convert`] 
| `convert` overloads
| xref:BloombergLP/bdlde/HexEncoder/endConvert-05.adoc[`endConvert`] 
| `endConvert` overloads
| xref:BloombergLP/bdlde/HexEncoder/isAcceptable.adoc[`isAcceptable`] 
| Return `true` if the input read so far by this encoder is considered syntactically complete, and `false` otherwise.
| xref:BloombergLP/bdlde/HexEncoder/isDone.adoc[`isDone`] 
| Return `true` if this encoder is in the done state with no pending output.
| xref:BloombergLP/bdlde/HexEncoder/isError.adoc[`isError`] 
| Return `true` if this encoder cannot achieve an acceptable result.
| xref:BloombergLP/bdlde/HexEncoder/isInitialState.adoc[`isInitialState`] 
| Return `true` if this encoder is in the initial state (i.e., as if no input had been consumed), and `false` otherwise.
| xref:BloombergLP/bdlde/HexEncoder/isUpperCase.adoc[`isUpperCase`] 
| Return `true` if this encoder represents values from 10 to 15 as uppercase letters(`A`‐`F`), and `false` if these values are represented as lowercase letters(`a`‐`f`).
| xref:BloombergLP/bdlde/HexEncoder/numOutputPending.adoc[`numOutputPending`] 
| Return the number of characters that would be output if `endConvert` were called with no output limit.
| xref:BloombergLP/bdlde/HexEncoder/outputLength.adoc[`outputLength`] 
| Return the total length of output emitted by this encoder.
| xref:BloombergLP/bdlde/HexEncoder/reset.adoc[`reset`] 
| Reset this encoder to its initial state (i.e., as if no input had been consumed).
|===



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