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

This `struct` contains functions for printing objects to output streams using various formatting modes.

== Synopsis

Declared in `<balxml_typesprintutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct TypesPrintUtil;
----

== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/TypesPrintUtil/print.adoc[`print`] 
| Format the specified `object` to the specified output `stream` using the specified `formattingMode` and the optionally specified `encoderOptions` and return a reference to `stream`. The behavior is undefined unless the parameterized `TYPE` and the `formattingMode` combination is supported (supported combinations are listed in the component‐level documentation).
| xref:BloombergLP/balxml/TypesPrintUtil/printBase64.adoc[`printBase64`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_BASE64` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`.
| xref:BloombergLP/balxml/TypesPrintUtil/printDecimal.adoc[`printDecimal`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_DEC` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`.
| xref:BloombergLP/balxml/TypesPrintUtil/printDefault.adoc[`printDefault`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_DEFAULT` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`.
| xref:BloombergLP/balxml/TypesPrintUtil/printHex.adoc[`printHex`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_HEX` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`.
| xref:BloombergLP/balxml/TypesPrintUtil/printList.adoc[`printList`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_LIST` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`.
| xref:BloombergLP/balxml/TypesPrintUtil/printText.adoc[`printText`] 
| Format the specified `object` to the specified output `stream` using the `bdlat_FormattingMode::e_TEXT` formatting mode and the optionally specified `encoderOptions`. Return a reference to `stream`. The string representation of `object` must be a valid UTF‐8 string and may not contain any control characters other than TAB, NL, and CR (i.e., no binary data) unless `encoderOptions‐>allowControlCharacters()` is `true`, in which control characters will be encoded as is. Upon detecting an invalid byte, the output stops and the `failbit` is be set on the output `stream`. In the case of an invalid byte in a multi‐byte character, the output stops after the previous character and no byte in this character is output.
|===



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