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

This class implements a guard that saves the state of a `basic_ostream` and restores that state upon destruction of the guard.

== Synopsis

Declared in `<bslim_formatguard.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FormatGuard;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslim/FormatGuard/2constructor.adoc[`FormatGuard`]         [.small]#[constructor]#
| Create a `FormatGuard` object saving the state of the specified `stream`.
| xref:BloombergLP/bslim/FormatGuard/2destructor.adoc[`~FormatGuard`] [.small]#[destructor]#
| Restore all the saved state to the stream that was passed to the constructor.
|===



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