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

A type erased wrapper around arbitrary sink objects specifically used as an argument to `Format()`.

== Synopsis

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

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

== Description

All the object has to do define an overload of `AbslFormatFlush()` for the sink, usually by adding a ADL‐based free function in the same namespace as the sink:

void AbslFormatFlush(MySink* dest, absl::string_view part);

where `dest` is the pointer passed to `absl::Format()`. The function should append `part` to `dest`.

FormatRawSink does not own the passed sink object. The passed object must outlive the FormatRawSink.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:absl/FormatRawSink/2constructor.adoc[`FormatRawSink`]         [.small]#[constructor]#
| Implicitly convert from any type that provides the hook function as described above.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `absl::str_format_internal::FormatRawSinkImpl`
| 
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:absl/Format.adoc[`Format`]
| Writes a formatted string to an arbitrary sink object (implementing the `absl::FormatRawSink` interface), using a format string and zero or more additional arguments.
| xref:absl/FormatUntyped.adoc[`FormatUntyped`]
| Writes a formatted string to an arbitrary sink object (implementing the `absl::FormatRawSink` interface), using an `UntypedFormatSpec` and zero or more additional arguments.
|===


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