View Source Cldr.Number.Symbol (Cldr Numbers v2.32.0)
Functions to manage the symbol definitions for a locale and number system.
Summary
Functions
Returns a list of all decimal symbols defined by the locales configured in the given backend as a list.
Returns a list of all decimal symbols defined by the locales configured in the given backend as a string.
Returns a list of all grouping symbols defined by the locales configured in the given backend as a list.
Returns a list of all grouping symbols defined by the locales configured in the given backend as a string.
Returns a map of Cldr.Number.Symbol.t structs of the number symbols for each
of the number systems of a locale.
Returns the number symbols for a specific locale and number system.
Types
@type t() :: %Cldr.Number.Symbol{ decimal: String.t(), exponential: String.t(), group: String.t(), infinity: String.t(), list: String.t(), minus_sign: String.t(), nan: String.t(), per_mille: String.t(), percent_sign: String.t(), plus_sign: String.t(), superscripting_exponent: String.t(), time_separator: String.t() }
Functions
Returns a list of all decimal symbols defined by the locales configured in the given backend as a list.
Arguments
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
Returns a list of all decimal symbols defined by the locales configured in the given backend as a string.
This string can be used as a character class when builing a regular expression.
Arguments
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
Returns a list of all grouping symbols defined by the locales configured in the given backend as a list.
Arguments
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
Returns a list of all grouping symbols defined by the locales configured in the given backend as a string.
This string can be used as a character class when builing a regular expression.
Arguments
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
@spec number_symbols_for( Cldr.LanguageTag.t() | Cldr.Locale.locale_name(), Cldr.backend() ) :: {:ok, map()} | {:error, {module(), String.t()}}
Returns a map of Cldr.Number.Symbol.t structs of the number symbols for each
of the number systems of a locale.
Arguments
- localeis any valid locale name returned by- Cldr.known_locale_names/1or a- Cldr.LanguageTagstruct returned by- Cldr.Locale.new!/2. The default is- Cldr.get_locale/1.
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
Example:
iex> Cldr.Number.Symbol.number_symbols_for("th", TestBackend.Cldr)
{:ok, %{
   latn: %Cldr.Number.Symbol{
     decimal: ".",
     exponential: "E",
     group: ",",
     infinity: "∞",
     list: ";",
     minus_sign: "-",
     nan: "NaN",
     per_mille: "‰",
     percent_sign: "%",
     plus_sign: "+",
     superscripting_exponent: "×",
     time_separator: ":"
   },
   thai: %Cldr.Number.Symbol{
     decimal: ".",
     exponential: "E",
     group: ",",
     infinity: "∞",
     list: ";",
     minus_sign: "-",
     nan: "NaN",
     per_mille: "‰",
     percent_sign: "%",
     plus_sign: "+",
     superscripting_exponent: "×",
     time_separator: ":"
   }
 }}@spec number_symbols_for( Cldr.LanguageTag.t() | Cldr.Locale.locale_name(), Cldr.Number.System.system_name(), Cldr.backend() ) :: {:ok, map()} | {:error, {Cldr.NoNumberSymbols, String.t()}}
Returns the number symbols for a specific locale and number system.
Options
- localeis any valid locale name returned by- Cldr.known_locale_names/1or a- Cldr.LanguageTagstruct returned by- Cldr.Locale.new!/2. The default is- Cldr.get_locale/1.
- number_systemis any number system name returned by- Cldr.known_number_systems/0or a number system type returned by- Cldr.known_number_system_types/0
- backendis any module that includes- use Cldrand therefore is a- Cldrbackend module
Example
iex> Cldr.Number.Symbol.number_symbols_for("th", "thai", TestBackend.Cldr)
{:ok, %Cldr.Number.Symbol{
   decimal: ".",
   exponential: "E",
   group: ",",
   infinity: "∞",
   list: ";",
   minus_sign: "-",
   nan: "NaN",
   per_mille: "‰",
   percent_sign: "%",
   plus_sign: "+",
   superscripting_exponent: "×",
   time_separator: ":"
 }}