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

Namespace for XML encoding, decoding, and formatting components.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Base64Parser.adoc[`Base64Parser`] 
| This is a push parser for supported Base64 types (`bsl::vector<char>` or `bsl::string`).
| xref:BloombergLP/balxml/ConfigSchema.adoc[`ConfigSchema`] 
| Provide a namespace for the service configuration schema.
| xref:BloombergLP/balxml/Decoder.adoc[`Decoder`] 
| Engine for decoding value‐semantic objects in XML format.
| xref:BloombergLP/balxml/DecoderOptions.adoc[`DecoderOptions`] 
| Options for controlling the XML decoding process.
| xref:BloombergLP/balxml/Decoder_ChoiceContext.adoc[`Decoder_ChoiceContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ElementContext.adoc[`Decoder_ElementContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ErrorLogger.adoc[`Decoder_ErrorLogger`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_InstantiateContext-01.adoc[`Decoder_InstantiateContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ListParser.adoc[`Decoder_ListParser`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_NillableContext.adoc[`Decoder_NillableContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseAttribute.adoc[`Decoder_ParseAttribute`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseAttribute_executeImpProxy.adoc[`Decoder_ParseAttribute_executeImpProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseAttribute_executeProxy.adoc[`Decoder_ParseAttribute_executeProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseNillableObject.adoc[`Decoder_ParseNillableObject`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseNillableObject_executeImpProxy.adoc[`Decoder_ParseNillableObject_executeImpProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseObject.adoc[`Decoder_ParseObject`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseObject_executeImpProxy.adoc[`Decoder_ParseObject_executeImpProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseObject_executeProxy.adoc[`Decoder_ParseObject_executeProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseSequenceSimpleContent.adoc[`Decoder_ParseSequenceSimpleContent`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_ParseSequenceSubElement.adoc[`Decoder_ParseSequenceSubElement`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_PrepareSequenceContext.adoc[`Decoder_PrepareSequenceContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_PushParserContext.adoc[`Decoder_PushParserContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_SelectContext.adoc[`Decoder_SelectContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_SequenceContext.adoc[`Decoder_SequenceContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_SimpleContext.adoc[`Decoder_SimpleContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_StdStringContext.adoc[`Decoder_StdStringContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_StdVectorCharContext.adoc[`Decoder_StdVectorCharContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_UTF8Context.adoc[`Decoder_UTF8Context`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_UnknownElementContext.adoc[`Decoder_UnknownElementContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_decodeImpProxy.adoc[`Decoder_decodeImpProxy`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/ElementAttribute.adoc[`ElementAttribute`] 
| Class to represent the properties of an attribute in an XML element tag.
| xref:BloombergLP/balxml/Encoder.adoc[`Encoder`] 
| This `class` contains the parameterized `encode` functions that encode `bdlat` types in XML format.
| xref:BloombergLP/balxml/EncoderOptions.adoc[`EncoderOptions`] 
| Options for performing XML encodings.
| xref:BloombergLP/balxml/Encoder_Context.adoc[`Encoder_Context`] 
| This `struct` contains state that is maintained during encoding.
| xref:BloombergLP/balxml/Encoder_EncodeObject.adoc[`Encoder_EncodeObject`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/Encoder_EncodeObject_executeImpProxy.adoc[`Encoder_EncodeObject_executeImpProxy`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/Encoder_EncodeObject_executeProxy.adoc[`Encoder_EncodeObject_executeProxy`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/Encoder_EncodeValue.adoc[`Encoder_EncodeValue`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/Encoder_EncodeValue_executeImpProxy.adoc[`Encoder_EncodeValue_executeImpProxy`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/Encoder_OptionsCompatibilityUtil.adoc[`Encoder_OptionsCompatibilityUtil`] 
| Component‐private `struct`. Do not use.
| xref:BloombergLP/balxml/Encoder_SequenceFirstPass.adoc[`Encoder_SequenceFirstPass`] 
| Component private class. Do not use.
| xref:BloombergLP/balxml/Encoder_SequenceFirstPass_addAttributeImpProxy.adoc[`Encoder_SequenceFirstPass_addAttributeImpProxy`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/Encoder_SequenceFirstPass_addAttributeProxy.adoc[`Encoder_SequenceFirstPass_addAttributeProxy`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/Encoder_SequenceSecondPass.adoc[`Encoder_SequenceSecondPass`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/EncodingStyle.adoc[`EncodingStyle`] 
| Enumeration of encoding style (COMPACT or PRETTY). This struct is generated using bas_codegen.pl called by balxml/code_from_xsd.pl
| xref:BloombergLP/balxml/ErrorInfo.adoc[`ErrorInfo`] 
| This class provides detailed information for errors encountered during XML parsing.
| xref:BloombergLP/balxml/Formatter.adoc[`Formatter`] 
| Format XML tags, attributes, and data with indentation and wrapping.
| xref:BloombergLP/balxml/FormatterWhitespaceType.adoc[`FormatterWhitespaceType`] 
| This `struct` describes options available when outputting textual data of an element between its pair of opening and closing tags.
| xref:BloombergLP/balxml/Formatter_CompactImplState.adoc[`Formatter_CompactImplState`] 
| Compact‐formatter state for printing XML with minimal whitespace.
| xref:BloombergLP/balxml/Formatter_CompactImplStateId.adoc[`Formatter_CompactImplStateId`] 
| This `struct` provides a namespace for enumerating a set of labels for distinct states of `Formatter_CompactImplState`.
| xref:BloombergLP/balxml/Formatter_CompactImplUtil.adoc[`Formatter_CompactImplUtil`] 
| Utility operations for compact (minimal‐whitespace) XML formatting.
| xref:BloombergLP/balxml/Formatter_Mode.adoc[`Formatter_Mode`] 
| This component‐private utility `struct` provides a namespace for enumerating the set of formatting modes that the `Formatter` can take.
| xref:BloombergLP/balxml/Formatter_PrettyImplState.adoc[`Formatter_PrettyImplState`] 
| This class provides an in‐core, value‐semantic attribute type that maintains state for pretty‐printing an XML document.
| xref:BloombergLP/balxml/Formatter_PrettyImplStateId.adoc[`Formatter_PrettyImplStateId`] 
| This `struct` provides a namespace for enumerating the set of labels for distinct states of `Formatter_PrettyImplState`.
| xref:BloombergLP/balxml/Formatter_PrettyImplUtil.adoc[`Formatter_PrettyImplUtil`] 
| This utility `struct` provides a namespace for pretty‐printing XML.
| xref:BloombergLP/balxml/Formatter_State.adoc[`Formatter_State`] 
| Component‐private variant holding compact or pretty formatter state.
| xref:BloombergLP/balxml/Formatter_StreamHolder.adoc[`Formatter_StreamHolder`] 
| Component‐private holder for the `bsl::ostream` used by `Formatter`.
| xref:BloombergLP/balxml/HexParser.adoc[`HexParser`] 
| This is a push parser for supported Hex types (`bsl::vector<char>` or `bsl::string`).
| xref:BloombergLP/balxml/HexParser_Helper.adoc[`HexParser_Helper`] 
| Implementation helper for `HexParser`.
| xref:BloombergLP/balxml/ListParser.adoc[`ListParser`] 
| This is a push parser for lists.
| xref:BloombergLP/balxml/MiniReader.adoc[`MiniReader`] 
| This `class` provides a concrete and efficient implementation of the `Reader` protocol.
| xref:BloombergLP/balxml/NamespaceRegistry.adoc[`NamespaceRegistry`] 
| Mapping that associates a unique integer with each registered namespace URI.
| xref:BloombergLP/balxml/PrefixStack.adoc[`PrefixStack`] 
| `PrefixStack` allows associating a unique integer (namespace ID) with prefix.
| xref:BloombergLP/balxml/Reader.adoc[`Reader`] 
| This abstract class defines an interface for fast, forward‐only access to XML data.
| xref:BloombergLP/balxml/TypesParserUtil.adoc[`TypesParserUtil`] 
| This `struct` contains functions for parsing input strings using various XML formatting modes.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseBase64.adoc[`TypesParserUtilImp_ParseBase64`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseDecimal.adoc[`TypesParserUtilImp_ParseDecimal`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseDefault.adoc[`TypesParserUtilImp_ParseDefault`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseHex.adoc[`TypesParserUtilImp_ParseHex`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseList.adoc[`TypesParserUtilImp_ParseList`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseListElementDefault.adoc[`TypesParserUtilImp_ParseListElementDefault`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesParserUtilImp_ParseText.adoc[`TypesParserUtilImp_ParseText`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtil.adoc[`TypesPrintUtil`] 
| This `struct` contains functions for printing objects to output streams using various formatting modes.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintBase64.adoc[`TypesPrintUtilImp_PrintBase64`] 
| Component‐private struct. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintDecimal.adoc[`TypesPrintUtilImp_PrintDecimal`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintDefault.adoc[`TypesPrintUtilImp_PrintDefault`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintHex.adoc[`TypesPrintUtilImp_PrintHex`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintList.adoc[`TypesPrintUtilImp_PrintList`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintListElementDefault.adoc[`TypesPrintUtilImp_PrintListElementDefault`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/TypesPrintUtilImp_PrintText.adoc[`TypesPrintUtilImp_PrintText`] 
| Component‐private class. Do not use.
| xref:BloombergLP/balxml/Utf8ReaderWrapper.adoc[`Utf8ReaderWrapper`] 
| Wrap a `Reader` and check that its input is valid UTF‐8.
| xref:BloombergLP/balxml/Util.adoc[`Util`] 
| Utility functions for `balxml`.
| xref:BloombergLP/balxml/ValidatingReader.adoc[`ValidatingReader`] 
| TBD Class description
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/operator_lshift-01e.adoc[`operator<<`] 
| Stream insertion operators
| xref:BloombergLP/balxml/operator_eq-06.adoc[`operator==`] 
| Equality operators
| xref:BloombergLP/balxml/operator_not_eq-0a.adoc[`operator!=`] 
| Inequality operators
|===



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