[#absl-StreamFormat]
= xref:absl.adoc[absl]::StreamFormat
:relfileprefix: ../
:mrdocs:

Writes to an output stream given a format string and zero or more arguments, generally in a manner that is more efficient than streaming the result of `absl&colon;&colon;StrFormat()`&period;

== Synopsis

Declared in `&lt;absl&sol;strings&sol;str&lowbar;format&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;typename&period;&period;&period; Args&gt;
&lsqb;&lsqb;nodiscard&rsqb;&rsqb;
str&lowbar;format&lowbar;internal::Streamable
StreamFormat(
    xref:absl/FormatSpec.adoc[FormatSpec&lt;Args&period;&period;&period;&gt;] const& format,
    Args const&&period;&period;&period; args);
----

== Description

The returned object must be streamed before the full expression ends&period;

Example&colon;

std&colon;&colon;cout &lt;&lt; StreamFormat(&quot;%12&period;6f&quot;, 3&period;14)&semi;

== Return Value

A streamable object that writes the formatted output&period;

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *format*
| The format string&period;
| *args*
| The arguments substituted into the format string&period;
|===


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