Specs

to_string!(
  list_or_number :: Cldr.Unit.value() | Cldr.Unit.t() | [Cldr.Unit.t()]
) :: String.t() | no_return()

Formats a number into a string according to a unit definition for the current process's locale and backend or raises on error.

The curent process's locale is set with Cldr.put_locale/1.

See Cldr.Unit.to_string!/3 for full details.

Specs

to_string!(
  Cldr.Unit.value() | Cldr.Unit.t() | [Cldr.Unit.t()],
  Cldr.backend() | Keyword.t(),
  Keyword.t()
) :: String.t() | no_return()

Formats a number into a string according to a unit definition for the current process's locale and backend or raises on error.

During processing any :format_options of a t:Cldr.Unit are merged with options with options taking precedence.

Arguments

• number is any number (integer, float or Decimal) or a t:Cldr.Unit struct

• backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0.

• options is a keyword list

Options

• :unit is any unit returned by Cldr.Unit.known_units/0. Ignored if the number to be formatted is a t:Cldr.Unit struct

• :locale is any valid locale name returned by Cldr.known_locale_names/0 or a Cldr.LanguageTag struct. The default is Cldr.get_locale/0

• :style is one of those returned by Cldr.Unit.available_styles. The current styles are :long, :short and :narrow. The default is style: :long

• Any other options are passed to Cldr.Number.to_string/2 which is used to format the number

Returns

• formatted_string or

• raises an exception

Examples

iex> Cldr.Unit.Format.to_string! Cldr.Unit.new!(:gallon, 123), MyApp.Cldr
"123 gallons"

iex> Cldr.Unit.Format.to_string! Cldr.Unit.new!(:gallon, 1), MyApp.Cldr
"1 gallon"

iex> Cldr.Unit.Format.to_string! Cldr.Unit.new!(:gallon, 1), MyApp.Cldr, locale: "af"
"1 gelling"