mp_units::symbol_text

Synopsis

Declared in <mp-units/framework/symbol_text.h>

template<
    std::size_t N,
    std::size_t M>
class symbol_text
    : public /* implementation-defined */

Description

This class template is responsible for definition and handling of a symbol text representation. In the libary it is used to define symbols of units and prefixes. Each symbol can have two versions: UTF-8 and portable.

Base Classes

Name	Description
`/* implementation-defined */`

Member Functions

Name	Description
`symbol_text` [constructor]	Constructors
`ascii` [deprecated]	Deprecated accessor for the portable rendering; use `portable()` instead
`empty`	Checks whether both the UTF-8 and the portable renderings of the symbol are empty
`portable`	Returns the portable rendering of the symbol
`unicode` [deprecated]	Deprecated accessor for the UTF-8 rendering; use `utf8()` instead
`utf8`	Returns the UTF-8 rendering of the symbol

Data Members

Name	Description
`portable_`	The portable (basic literal character set) rendering of the symbol
`utf8_`	The UTF-8 rendering of the symbol

Deduction Guides

Name	Description
`symbol_text<1, 1>`	Deduction guide for a `symbol_text` constructed from a single character
`symbol_text<N, M>`	Deduction guide for a `symbol_text` constructed from separate UTF-8 and portable fixed strings
`symbol_text<N, N>`	Deduction guide for a `symbol_text` constructed from a fixed string
`symbol_text<N - 1, M - 1>`	Deduction guide for a `symbol_text` constructed from separate UTF-8 and portable string literals
`symbol_text<N - 1, N - 1>`	Deduction guide for a `symbol_text` constructed from a narrow string literal

Template Parameters

Name	Description
N	The size of a UTF-8 symbol
M	The size of the portable symbol