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

Parses the fill and alignment part of a `std‐format‐spec` into `specs.`

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    std::forward_iterator It,
    typename Specs>
[[nodiscard]]
constexpr
It
parse_align(
    It begin,
    It end,
    Specs& specs,
    xref:mp_units/utility/fmt_align.adoc[fmt_align] default_align = fmt_align::none);
----

== Return Value

an iterator past the parsed fill/align part of the format spec

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

[cols="1,4"]
|===
| Name| Description
| *begin*
| the beginning of the range to parse; must be non‐empty
| *end*
| the end of the range to parse
| *specs*
| the specs object to update with the parsed fill and alignment
| *default_align*
| the alignment to use when the format spec does not request one
|===


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