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

Temporary proxy for quoting a `bsl::basic_string` in stream I/O.

== Synopsis

Declared in `<bslstl_iomanip.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_CHAR_TYPE,
    class t_CHAR_TRAITS,
    class t_ALLOC>
class IoManip_QuotedStringFormatter;
----

== Description

Private class: do not use outside of `bslstl_iomanip.h` header. This private class provides a temporary storage that can be extracted to/from a stream and provides data to the standard implementation of the `quoted` function. Note that this class does not contain the storage itself, but only points to an external object. Note that `QuotedStringViewFormatter` is designed so that its objects are returned as temporary objects (of opaque type) from `bsl::quoted`, and then passed to a streaming operator; it serves as a temporary proxy for a string value.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslstl/IoManip_QuotedStringFormatter/2constructor.adoc[`IoManip_QuotedStringFormatter`]         [.small]#[constructor]#
| Create an object pointing to the specified `str` and having the optionally specified `delim` and `escape` characters.
| xref:BloombergLP/bslstl/IoManip_QuotedStringFormatter/delim.adoc[`delim`] 
| Return the delimiter character used by this formatter.
| xref:BloombergLP/bslstl/IoManip_QuotedStringFormatter/escape.adoc[`escape`] 
| Return the escape character.
| xref:BloombergLP/bslstl/IoManip_QuotedStringFormatter/str.adoc[`str`] 
| Return a pointer providing modifiable access to the underlying string.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/quoted-0c.adoc[`::bsl::quoted`]
| Return a streamable object that quotes the specified `value`.
|===


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