Returns the textual symbol of a unit

Synopsis

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

template<
    unit_symbol_formatting fmt = unit_symbol_formatting{},
    typename CharT = char,
    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 should not be discarded.

Template Parameters

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

Name

Description

u

the unit to obtain the symbol of

Created with MrDocs