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

Returns the textual symbol of a unit

== Synopsis

Declared in `<mp‐units/framework/unit_text.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/unit_symbol_formatting.adoc[unit_symbol_formatting] fmt = unit_symbol_formatting{},
    typename CharT = char,
    xref:mp_units/Unit.adoc[Unit] U>
[[nodiscard]]
consteval
std::basic_string_view<CharT>
unit_symbol(U u);
----

== Return Value

a view over the unit's symbol

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

[cols="1,4"]
|===
| Name| Description
| *fmt*
| the formatting options to use
| *CharT*
| the character type used to represent the symbol
| *U*
| the unit to obtain the symbol of
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *u*
| the unit to obtain the symbol of
|===


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