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

This component‐private, in‐core, value‐semantic class provides a variant that can be inhabited by an object of either the component‐private `Formatter_CompactImplState` type or the component‐private `Formatter_PrettyImplState` type.

== Synopsis

Declared in `<balxml_formatter.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/Mode.adoc[`Mode`] 
| Formatting mode type used by this class.
| xref:BloombergLP/balxml/Formatter_State/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this class.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/2constructor-07.adoc[`Formatter_State`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/Formatter_State/2destructor.adoc[`~Formatter_State`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/balxml/Formatter_State/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` and return a reference to this object.
| xref:BloombergLP/balxml/Formatter_State/get_allocator.adoc[`get_allocator`] 
| Return the allocator associated with this object.
| xref:BloombergLP/balxml/Formatter_State/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<Formatter_State, UsesBslmaAllocator>`] 
| `Formatter_State` uses a `bslma` allocator.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/d_compact.adoc[`d_compact`] [.small]#[variant member]#
| Compact‐formatter state when `d_mode` is `Mode::e_COMPACT`.
| xref:BloombergLP/balxml/Formatter_State/d_pretty.adoc[`d_pretty`] [.small]#[variant member]#
| Pretty‐formatter state when `d_mode` is `Mode::e_PRETTY`.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balxml/Formatter.adoc[BloombergLP::balxml::Formatter]`
| This class provides a set of XML‐style formatting utilities that enable transparent indentation and wrapping for users attempting to format data with XML tags and attributes. A formatter object is instantiated with a pointer to an output stream or streambuf. Users can then use the provided utilities to write element tags, attributes, data in a valid XML sequence into the underlying stream.
|===


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