BloombergLP::balxml::Encoder

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

Synopsis

Declared in <balxml_encoder.h>

class Encoder;

Member Functions

NameDescription
Encoder [constructor]Constructors
~Encoder [destructor]Destroy this object. This destruction has no effect on objects pointed-to by the pointers provided at construction.
encode encode overloads
encodeAny encodeAny overloads
encodeAnyToStream encodeAnyToStream overloads
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.
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.
errorStream Return pointer to the error stream.
isCompact Return true if the encoding style in the encoder options is defined as EncodingStyle::BAEXML_COMPACT, and false otherwise.
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.
options Return the encoder options.
warningStream Return pointer to the warning stream.
operator BloombergLP::bslmf::NestedTraitDeclaration<Encoder, UsesBslmaAllocator> Declare that this type uses a bslma allocator.

Friends

NameDescription
BloombergLP::balxml::Encoder_ContextThis 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.