[#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::StrFormat()`.

== Synopsis

Declared in `<absl/strings/str_format.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename... Args>
[[nodiscard]]
str_format_internal::Streamable
StreamFormat(
    xref:absl/FormatSpec.adoc[FormatSpec<Args...>] const& format,
    Args const&... args);
----

== Description

The returned object must be streamed before the full expression ends.

Example:

std::cout << StreamFormat("%12.6f", 3.14);

== Return Value

A streamable object that writes the formatted output.

[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.
| *args*
| The arguments substituted into the format string.
|===


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