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

This unconstrained (value‐semantic) class provides an access to the current state of the format operation and is used for testing `bsl::formatter` specializations.

== Synopsis

Declared in `<bslfmt_mockformatcontext.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_CHAR>
class MockFormatContext;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockFormatContext/Arg-03.adoc[`Arg`] 
| Type of a format argument held by this context.
| xref:BloombergLP/bslfmt/MockFormatContext/char_type.adoc[`char_type`] 
| Character type used for formatting.
| xref:BloombergLP/bslfmt/MockFormatContext/formatter_type.adoc[`formatter_type`] 
| Formatter type for values of type `t_TYPE` with character type `t_CHAR`.
| xref:BloombergLP/bslfmt/MockFormatContext/iterator.adoc[`iterator`] 
| Output iterator type used by this context.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockFormatContext/2constructor-0c.adoc[`MockFormatContext`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslfmt/MockFormatContext/advance_to.adoc[`advance_to`] 
| Advance the output iterator to the position referred by the specified `it`.
| xref:BloombergLP/bslfmt/MockFormatContext/arg-0f.adoc[`arg`] 
| Return the argument with the specified `id` or the default constructed object if there is no argument with such `id`.
| xref:BloombergLP/bslfmt/MockFormatContext/finalString.adoc[`finalString`] 
| Return output string.
| xref:BloombergLP/bslfmt/MockFormatContext/out.adoc[`out`] 
| Return this object's output iterator.
|===



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