[#mp_units-utility-write_padded]
= xref:mp_units.adoc[mp_units]::xref:mp_units/utility.adoc[utility]::write_padded
:relfileprefix: ../../
:mrdocs:

Writes a string to an output iterator with fill/align/width padding.

== Synopsis

Declared in `<mp‐units/utility/format.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename Char,
    std::output_iterator<Char> Out>
constexpr
Out
write_padded(
    Out out,
    std::basic_string_view<Char> s,
    int width,
    xref:mp_units/utility/fmt_align.adoc[fmt_align] align,
    xref:mp_units/utility/fill_t.adoc[fill_t<Char>] const& fill);
----

== Description

Avoids instantiating format_to/vformat_to infrastructure for the common padding use‐case inside formatter<Unit>, formatter<Dimension>, and formatter<quantity> specializations.

== Return Value

the output iterator after writing the padded string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *out*
| the output iterator to write to
| *s*
| the string to write
| *width*
| the minimum field width; `s` is padded with `fill` to reach it
| *align*
| how `s` is aligned within the padded field
| *fill*
| the character(s) used to pad `s` up to `width`
|===


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