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

Format context for testing `bsl&colon;&colon;formatter` specializations&period;

== Synopsis

Declared in `&lt;bslfmt&lowbar;mockformatcontext&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;CHAR&gt;
class MockFormatContext;
----

== Description

This unconstrained (value&hyphen;semantic) class provides access to the current state of the format operation&period;

== Type Aliases

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


== 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&lowbar;to`] 
| Advance the output iterator to the position referred by the specified `it`&period;
| 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`&period;
| xref:BloombergLP/bslfmt/MockFormatContext/finalString.adoc[`finalString`] 
| Return output string&period;
| xref:BloombergLP/bslfmt/MockFormatContext/out.adoc[`out`] 
| Return this object&apos;s output iterator&period;
|===



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