[#BloombergLP-bslfmt-Streamed-0f9]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::Streamed
:relfileprefix: ../../
:mrdocs:

This class provides a wrapper to enable a streamable type to be used with `bsl::format` (and `std::format`) when no formatter specialization is provided (the type is not formattable). Note that it is possible to use this wrapper with types that have a formatter, if the compiler supports it we give a compilation warning directing the user to use the existing formatter instead of wrapping to use the streaming operator.

== Synopsis

Declared in `<bslfmt_streamed.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/Streamed-0f9/2constructor-00.adoc[`Streamed`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslfmt/Streamed-0f9/object.adoc[`object`] 
| Return a non‐modifiable reference to the wrapped object.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/streamed-05.adoc[BloombergLP::bslfmt::streamed]`
| Create and return a `Streamed` wrapper for the specified `object` when `t_STREAMABLE2` is already formattable (emits a deprecation warning).
| `xref:BloombergLP/bslfmt/streamed-0f3.adoc[BloombergLP::bslfmt::streamed]`
| Create and return a `Streamed` wrapper for the specified `object` when `t_STREAMABLE2` is not formattable.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/streamed-09.adoc[`streamed`]
| Create and return a `bslfmt::Streamed` (wrapper) object for the specified streamable `object`. The behavior is undefined unless `t_STREAMABLE` has a standard and well‐behaved `std::ostream` output operator. This wrapper‐creator free function to support compilation with no CTAD (Class Template Argument Deduction); see (#Usage). Notice that for compilations that support the `bsl::formattable` trait we define two concept‐driven overloads of this function, one of which will warn the user (compiler warning) if a `bsl::formatter` already exists for the type they try to streamed‐wrap.
|===


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