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

Bloomberg formatting library namespace.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/EnableStreamedFormatter.adoc[`EnableStreamedFormatter`] 
| Boolean trait that enables streamed formatting of a type.
| xref:BloombergLP/bslfmt/FormatSpecificationParser.adoc[`FormatSpecificationParser`] 
| Mechanism for parsing Standard C++ format‐specification sections.
| xref:BloombergLP/bslfmt/FormatSpecificationParserEnums.adoc[`FormatSpecificationParserEnums`] 
| Namespace struct holding enums used for parsing.
| xref:BloombergLP/bslfmt/Format_ArgUtil.adoc[`Format_ArgUtil`] 
| Component‐private utilities for constructing format‐argument arrays.
| xref:BloombergLP/bslfmt/Format_ArgsStore.adoc[`Format_ArgsStore`] 
| Component‐private store of `basic_format_arg` objects.
| xref:BloombergLP/bslfmt/Format_ArgsUtil.adoc[`Format_ArgsUtil`] 
| Utility functions for manipulating format argument types.
| xref:BloombergLP/bslfmt/Format_ContextFactory.adoc[`Format_ContextFactory`] 
| Utility factory for constructing `basic_format_context` objects.
| xref:BloombergLP/bslfmt/Format_ContextOutputIteratorBase.adoc[`Format_ContextOutputIteratorBase`] 
| This component‐private type is an abstract base required to type‐erase output iterators as required by the `format_context` and `wformat_context` typedefs.
| xref:BloombergLP/bslfmt/Format_ContextOutputIteratorImpl.adoc[`Format_ContextOutputIteratorImpl`] 
| Type‐erasing holder for a concrete output iterator.
| xref:BloombergLP/bslfmt/Format_ContextOutputIteratorRef.adoc[`Format_ContextOutputIteratorRef`] 
| Type‐erased output‐iterator interface used by format contexts.
| xref:BloombergLP/bslfmt/Format_String_TestUpdater.adoc[`Format_String_TestUpdater`] 
| This is a component‐private type which enables test drivers to work around the compile‐time restrictions in `basic_format_string` construction.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdBasicString-07.adoc[`FormatterBase_IsStdBasicString`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::basic_string`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdBasicStringView-09.adoc[`FormatterBase_IsStdBasicStringView`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::basic_string_view`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoCpp20FormattableType.adoc[`FormatterBase_IsStdChronoCpp20FormattableType`] 
| Simple trait type that tells is `t_TYPE` is an instance of any of the C++20 standard formattable `std::chrono` types.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoDuration-07.adoc[`FormatterBase_IsStdChronoDuration`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::duration`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoFileTime-08.adoc[`FormatterBase_IsStdChronoFileTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::file_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoGpsTime-0c.adoc[`FormatterBase_IsStdChronoGpsTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::gps_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoHhMmSs-01.adoc[`FormatterBase_IsStdChronoHhMmSs`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::hh_mm_ss`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoLocalTime-07.adoc[`FormatterBase_IsStdChronoLocalTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::local_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoPointInTimeType.adoc[`FormatterBase_IsStdChronoPointInTimeType`] 
| Simple trait type that tells is `t_TYPE` is an instance of any of the `std::chrono` types that deal with points in time.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoSysTime-0d.adoc[`FormatterBase_IsStdChronoSysTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::sys_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoTaiTime-014.adoc[`FormatterBase_IsStdChronoTaiTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::tai_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoTimeType.adoc[`FormatterBase_IsStdChronoTimeType`] 
| Simple trait type that tells is `t_TYPE` is an instance of any of `std::chrono::*_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoUtcTime-0a7.adoc[`FormatterBase_IsStdChronoUtcTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::utc_time`.
| xref:BloombergLP/bslfmt/FormatterBase_IsStdChronoZonedTime-034.adoc[`FormatterBase_IsStdChronoZonedTime`] 
| Simple trait type that tells is `t_TYPE` is an instance of `std::chrono::zoned_time`.
| xref:BloombergLP/bslfmt/FormatterCharUtil-059.adoc[`FormatterCharUtil`] 
| Namespace for character conversion utilities used by formatters.
| xref:BloombergLP/bslfmt/FormatterCharacter_CharacterOutput-0a.adoc[`FormatterCharacter_CharacterOutput`] 
| This struct provides a function that outputs the specified `value` to the specified `out`.
| xref:BloombergLP/bslfmt/FormatterCharacter_MakeUnsigned-07.adoc[`FormatterCharacter_MakeUnsigned`] 
| Meta‐function yielding the unsigned analogue of a character type.
| xref:BloombergLP/bslfmt/FormatterFloating_Base.adoc[`FormatterFloating_Base`] 
| Implementation of floating‐point formatters and specification parsing.
| xref:BloombergLP/bslfmt/FormatterIntegralBase.adoc[`FormatterIntegralBase`] 
| Base class for integral and integral‐like `bsl::formatter` specializations.
| xref:BloombergLP/bslfmt/FormatterIntegral_Category-0c.adoc[`FormatterIntegral_Category`] 
| This struct provides a function that returns a category of the formatter in accordance with the (template parameter) `t_VALUE_TYPE`.
| xref:BloombergLP/bslfmt/FormatterPointer_Nullptr.adoc[`FormatterPointer_Nullptr`] 
| This struct is a specialization of the `bsl::formatter` template for the `bsl::nullptr_t`.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue.adoc[`FormatterSpecificationNumericValue`] 
| Value‐semantic type holding a category and optional integral value.
| xref:BloombergLP/bslfmt/FormatterSpecificationNumericValue_ArgVisitor.adoc[`FormatterSpecificationNumericValue_ArgVisitor`] 
| Visitor that extracts an integral nested format‐argument value.
| xref:BloombergLP/bslfmt/FormatterString_GraphemeCluster.adoc[`FormatterString_GraphemeCluster`] 
| [*PRIVATE*]Characterizes a Unicode grapheme cluster.
| xref:BloombergLP/bslfmt/FormatterTestUtil-00.adoc[`FormatterTestUtil`] 
| Namespace for test helpers that verify `bslfmt` formatter behavior.
| xref:BloombergLP/bslfmt/FormatterTestUtil_Oracle-0ff.adoc[`FormatterTestUtil_Oracle`] 
| Namespace for standard‐library formatting oracles used in tests.
| xref:BloombergLP/bslfmt/FormatterUnicodeData.adoc[`FormatterUnicodeData`] 
| [*PRIVATE*]Namespace for generated Unicode character data tables.
| xref:BloombergLP/bslfmt/MockFormatContext.adoc[`MockFormatContext`] 
| Format context for testing `bsl::formatter` specializations.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator.adoc[`MockFormatContext_Iterator`] 
| This class template provides an output iterator to the `MockFormatContext` output buffer allowing appending formatted data.
| xref:BloombergLP/bslfmt/MockParseContext.adoc[`MockParseContext`] 
| This class template provides an access to the format specification current parsing state.
| xref:BloombergLP/bslfmt/PadUtil.adoc[`PadUtil`] 
| This `struct` serves as a namespace for static functions related to padding output by bslfmt.
| xref:BloombergLP/bslfmt/StandardFormatSpecification.adoc[`StandardFormatSpecification`] 
| A general mechanism to parse and validate a Standard format specification string for a given argument type.
| xref:BloombergLP/bslfmt/Streamed-0f9.adoc[`Streamed`] 
| Formattable wrapper that uses `ostream` `operator<<` to format a type.
| xref:BloombergLP/bslfmt/StreamedFormatter.adoc[`StreamedFormatter`] 
| This class provides the implementations of `parse` and `format` for formatters that format a type using its streaming operator.
| xref:BloombergLP/bslfmt/Streamed_NoWarningConstructorTag.adoc[`Streamed_NoWarningConstructorTag`] 
| A _component private_ tag type used to internally construct a `Streamed` object without a warning (about an already existing formatter).
| xref:BloombergLP/bslfmt/TestSpecificationGenerator.adoc[`TestSpecificationGenerator`] 
| Generator of exhaustive standard formatting‐specification combinations.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_BoolOption.adoc[`TestSpecificationGenerator_BoolOption`] 
| This class is an implementation of the `TestSpecificationGenerator_Option` for options that have only two states: they are either present or not.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_Option.adoc[`TestSpecificationGenerator_Option`] 
| Base class for linked option nodes in a `TestSpecificationGenerator`.
| xref:BloombergLP/bslfmt/TestSpecificationGenerator_TypedOption.adoc[`TestSpecificationGenerator_TypedOption`] 
| Option node that iterates through a set of typed values.
| xref:BloombergLP/bslfmt/UnicodeCodePoint.adoc[`UnicodeCodePoint`] 
| Characterizes a Unicode code point as a set of integral attributes.
| xref:BloombergLP/bslfmt/basic_format_arg-0d.adoc[`basic_format_arg`] 
| Type‐erased format argument holding a value for formatting.
| xref:BloombergLP/bslfmt/basic_format_args.adoc[`basic_format_args`] 
| Access to a set of type‐erased formatting arguments.
| xref:BloombergLP/bslfmt/basic_format_context.adoc[`basic_format_context`] 
| A format context for use by `formatter::format()` partial specialization.
| xref:BloombergLP/bslfmt/basic_format_parse_context.adoc[`basic_format_parse_context`] 
| Parse context for use by `formatter::parse()` specializations.
| xref:BloombergLP/bslfmt/basic_format_string.adoc[`basic_format_string`] 
| Type that wraps a `basic_string_view` for use by formatting functions.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/format_args.adoc[`format_args`] 
| Alias for `basic_format_args` specialized on a `char` format context.
| xref:BloombergLP/bslfmt/format_context.adoc[`format_context`] 
| Alias for `basic_format_context` specialized on `char`.
| xref:BloombergLP/bslfmt/format_parse_context.adoc[`format_parse_context`] 
| Alias for `basic_format_parse_context` specialized on `char`.
| xref:BloombergLP/bslfmt/format_string.adoc[`format_string`] 
| Alias for a checked `char` format string.
| xref:BloombergLP/bslfmt/wformat_args.adoc[`wformat_args`] 
| Alias for `basic_format_args` specialized on a `wchar_t` format context.
| xref:BloombergLP/bslfmt/wformat_context.adoc[`wformat_context`] 
| Alias for `basic_format_context` specialized on `wchar_t`.
| xref:BloombergLP/bslfmt/wformat_parse_context.adoc[`wformat_parse_context`] 
| Alias for `basic_format_parse_context` specialized on `wchar_t`.
| xref:BloombergLP/bslfmt/wformat_string.adoc[`wformat_string`] 
| Alias for a checked `wchar_t` format string.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/format-08.adoc[`format`] 
| `format` overloads
| xref:BloombergLP/bslfmt/format_to-0b3.adoc[`format_to`] 
| `format_to` overloads
| xref:BloombergLP/bslfmt/format_to_n-07.adoc[`format_to_n`] 
| Format `args` per `fmtStr` into `out`, writing at most `maxNumChars`.
| xref:BloombergLP/bslfmt/formatted_size-00.adoc[`formatted_size`] 
| Return the length of the string that formatting `args` per `fmtStr` yields.
| xref:BloombergLP/bslfmt/make_format_args.adoc[`make_format_args`] 
| From the specified `fmt_args` return a type convertible to `format_arg_store` that is suitable for use by the `char`‐based `bslfmt::format` functions.
| xref:BloombergLP/bslfmt/make_wformat_args.adoc[`make_wformat_args`] 
| From the specified `fmt_args` return a type convertible to `format_arg_store` that is suitable for use by the `wchar_t`‐based `bslfmt::format` functions.
| xref:BloombergLP/bslfmt/print-054.adoc[`print`] 
| `print` overloads
| xref:BloombergLP/bslfmt/println-0ce.adoc[`println`] 
| `println` overloads
| xref:BloombergLP/bslfmt/streamed-07.adoc[`streamed`] 
| `streamed` overloads
| xref:BloombergLP/bslfmt/swap.adoc[`swap`] 
| Exchange the values of the specified `lhs` and `rhs`.
| xref:BloombergLP/bslfmt/vformat-0e.adoc[`vformat`] 
| `vformat` overloads
| xref:BloombergLP/bslfmt/vformat_to-0f.adoc[`vformat_to`] 
| `vformat_to` overloads
| xref:BloombergLP/bslfmt/visit_format_arg.adoc[`visit_format_arg`] 
| Invoke `visitor` on the value contained by `arg`.
| xref:BloombergLP/bslfmt/vprint_nonunicode-06.adoc[`vprint_nonunicode`] 
| `vprint_nonunicode` overloads
| xref:BloombergLP/bslfmt/vprint_nonunicode_buffered.adoc[`vprint_nonunicode_buffered`] 
| Format type‐erased `args` per `fmt` into a buffer and write to `stream`.
| xref:BloombergLP/bslfmt/vprint_unicode-07.adoc[`vprint_unicode`] 
| `vprint_unicode` overloads
| xref:BloombergLP/bslfmt/vprint_unicode_buffered.adoc[`vprint_unicode_buffered`] 
| Format type‐erased `args` per `fmt` into a buffer and write to `stream`.
|===


== Using Declarations

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/format_error.adoc[`format_error`] 
| Alias for `std::format_error` in the `bsl` namespace.
| xref:BloombergLP/bslfmt/format_to_n_result.adoc[`format_to_n_result`] 
| Alias for `std::format_to_n_result` in the `bslfmt` namespace.
|===



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