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

This class template provides an output iterator to the `MockFormatContext` output buffer allowing appending formatted data.

== Synopsis

Declared in `<bslfmt_mockformatcontext.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/difference_type.adoc[`difference_type`] 
| Difference type for iterator arithmetic.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/iterator_category.adoc[`iterator_category`] 
| Iterator category tag (output iterator).
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/pointer.adoc[`pointer`] 
| Pointer to a character in the output buffer.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/reference.adoc[`reference`] 
| Reference to a character in the output buffer.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/value_type.adoc[`value_type`] 
| Character type stored by the iterator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/2constructor.adoc[`MockFormatContext_Iterator`]         [.small]#[constructor]#
| Create an iterator, pointing to the specified `ptr` and having the specified `max` as the end of the buffer available for output. The behavior is undefined unless `max >=ptr`.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/operator_star.adoc[`operator*`] 
| Return a reference to the character referred to by this iterator.
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/operator_inc-01.adoc[`operator++`] 
| Increment operators
| xref:BloombergLP/bslfmt/MockFormatContext_Iterator/rawPointer.adoc[`rawPointer`] 
| Return a pointer pointing to the character referred to by this iterator.
|===



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