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

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

== Synopsis

Declared in `<bdlde_quotedprintableencoder.h>`

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

== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/EquivalenceClass.adoc[`EquivalenceClass`] 
| The input equivalence classes used by the encoder.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/LineBreakMode-0d.adoc[`LineBreakMode`] 
| Configuration governing how various forms of line breaks are interpreted while encoding.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/2constructor-01.adoc[`QuotedPrintableEncoder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/2destructor.adoc[`~QuotedPrintableEncoder`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/convert.adoc[`convert`] 
| Append to the buffer addressed by the specified `out` all pending output (if there is any) up to the optionally specified `maxNumOut` limit (default is negative, meaning no limit) and, when there is no pending output and `maxNumOut` is still not reached, begin to consume and encode a sequence of input characters starting at the specified `begin` position, up to but not including the specified `end` position, writing any resulting output in the specified `out` buffer up to the (cumulative) `maxNumOut` limit. If `maxNumOut` limit is reached, no further input will be consumed. Load into the specified `numOut` and `numIn` the number of output bytes produced and input bytes consumed, respectively. Return a non‐negative value on success and a negative value otherwise. A successful return status indicates the number of characters that would be output if `endConvert` were called subsequently with no output limit. These bytes _may_ be available for output if this method is called with a sufficiently large `maxNumOut`. Note that calling this method after `endConvert` has been invoked without an intervening `reset` call will place this instance in an error state, and return an error status. Note also that it is recommended that after all calls to `convert` are finished, the `endConvert` method be called to complete the encoding of any unprocessed input characters.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/endConvert.adoc[`endConvert`] 
| Terminate encoding for this encoder; write any retained output (e.g., from a previous call to `convert` with a non‐zero `maxNumOut` argument) to the specified `out` buffer. Optionally specify the `maxNumOut` limit on the number of bytes to output; if `maxNumOut` is negative, no limit is imposed. Load into the specified `numOut` the number of output bytes produced. Return a non‐negative value on success and a negative value otherwise. A successful return status indicates the number of characters that would be output if `endConvert` were called subsequently with no output limit. Any retained bytes are available on a subsequent call to `endConvert`. Once this method is called, no additional input may be supplied without an intervening call to `reset`; once this method returns a zero status, a subsequent call will place this encoder in the error state, and return an error status.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/isAccepting.adoc[`isAccepting`] 
| Return `true` if the input read so far by this encoder is considered syntactically complete, and `false` otherwise.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/isDone.adoc[`isDone`] 
| Return `true` if this encoder is in the done state (i.e., `endConvert` has been called and any additional input will result in an error), and if there is no pending output, and `false` otherwise.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/isError.adoc[`isError`] 
| Return `true` if there is no possibility of achieving an "acceptable" result, and `false` otherwise. Note that for an encoder, no input can cause an error; the possible errors result either from a call to the `convert` method after the `endConvert` method is called the first time, or from a call to either the `convert` or the `endConvert` methods after the `endConvert` method has returned successfully.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/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/QuotedPrintableEncoder/lineBreakMode-09.adoc[`lineBreakMode`] 
| Return the line break mode configured at the construction of this encoder.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/maxLineLength.adoc[`maxLineLength`] 
| Return the value for the maximum line length configured at the construction of this encoder.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/numOutputPending.adoc[`numOutputPending`] 
| Return the number of characters that would be output if `endConvert` were called with no output limit.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/outputLength.adoc[`outputLength`] 
| Return the total length of the output emitted by this encoder (possibly after one or more calls to the `convert` or the `input` methods) since its initial construction or the latest `reset`. Note that soft line breaks are included in the counts if added.
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/reset.adoc[`reset`] 
| Reset this encoder to its initial state (i.e., as if no input had been consumed).
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlde/QuotedPrintableEncoder/lineBreakModeToAscii.adoc[`lineBreakModeToAscii`] 
| Return the string representation exactly matching the enumerator name corresponding to the specified enumerator `mode`.
|===



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