[#BloombergLP-balxml-Encoder]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::Encoder
:relfileprefix: ../../
:mrdocs:

This `class` contains the parameterized `encode` functions that encode `bdlat` types in XML format.

== Synopsis

Declared in `<balxml_encoder.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Encoder/2constructor-0c5.adoc[`Encoder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/Encoder/2destructor.adoc[`~Encoder`] [.small]#[destructor]#
| Destroy this object. This destruction has no effect on objects pointed‐to by the pointers provided at construction.
| xref:BloombergLP/balxml/Encoder/encode-0c.adoc[`encode`] 
| `encode` overloads
| xref:BloombergLP/balxml/Encoder/encodeAny-0d.adoc[`encodeAny`] 
| `encodeAny` overloads
| xref:BloombergLP/balxml/Encoder/encodeAnyToStream-01b.adoc[`encodeAnyToStream`] 
| `encodeAnyToStream` overloads
| xref:BloombergLP/balxml/Encoder/encodeToStream.adoc[`encodeToStream`] 
| Encode the specified non‐modifiable `object` to the specified `stream`. Return 0 on success, and a non‐zero value otherwise. Note that the encoder will use encoder options, error and warning streams specified at the construction time.
| xref:BloombergLP/balxml/Encoder/errorSeverity.adoc[`errorSeverity`] 
| Return the severity of the most severe warning or error encountered during the last call to the `encode` method. The severity is reset each time `encode` is called.
| xref:BloombergLP/balxml/Encoder/errorStream.adoc[`errorStream`] 
| Return pointer to the error stream.
| xref:BloombergLP/balxml/Encoder/isCompact.adoc[`isCompact`] 
| Return `true` if the encoding style in the encoder options is defined as `EncodingStyle::BAEXML_COMPACT`, and `false` otherwise.
| xref:BloombergLP/balxml/Encoder/loggedMessages.adoc[`loggedMessages`] 
| Return a string containing any error, warning, or trace messages that were logged during the last call to the `encode` method. The log is reset each time `encode` is called.
| xref:BloombergLP/balxml/Encoder/options.adoc[`options`] 
| Return the encoder options.
| xref:BloombergLP/balxml/Encoder/warningStream.adoc[`warningStream`] 
| Return pointer to the warning stream.
| xref:BloombergLP/balxml/Encoder/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<Encoder, UsesBslmaAllocator>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balxml/Encoder_Context.adoc[BloombergLP::balxml::Encoder_Context]`
| This `struct` contains state that is maintained during encoding. It also contains methods for switching between pretty formatting and compact formatting, based on the encoding options.
|===


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