Cldr Units

v2.5.1

Cldr Units

Cldr Units v2.5.1 Cldr.Unit.Conversion View Source

Unit conversion functions for the units defined in Cldr.

Link to this section Summary

Functions

convert(from, to_unit)

Convert one unit into another unit of the same unit type (length, volume, mass, ...)

convert!(unit, to_unit)

Convert one unit into another unit of the same unit type (length, volume, mass, ...) and raises on a unit type mismatch

direct_factors()
factors()

Link to this section Functions

Link to this function

convert(from, to_unit) View Source 
convert(Cldr.Unit.t(), Cldr.Unit.unit()) ::
  Cldr.Unit.t() | {:error, {module(), String.t()}}

Convert one unit into another unit of the same unit type (length, volume, mass, ...)

Options

Returns

  • a Unit.t of the unit type to_unit or

  • {:error, {exception, message}}

Examples 

iex> Cldr.Unit.convert Cldr.Unit.new!(:celsius, 0), :fahrenheit
#Unit<:fahrenheit, 32.0>

iex> Cldr.Unit.convert Cldr.Unit.new!(:fahrenheit, 32), :celsius
#Unit<:celsius, 0.0>

iex> Cldr.Unit.convert Cldr.Unit.new!(:mile, 1), :foot
#Unit<:foot, 5279.945925937846>

iex> Cldr.Unit.convert Cldr.Unit.new!(:mile, 1), :gallon
{:error, {Cldr.Unit.IncompatibleUnitsError,
          "Operations can only be performed between units of the same type. Received :mile and :gallon"}}
Link to this function

convert!(unit, to_unit) View Source 
convert!(Cldr.Unit.t(), Cldr.Unit.unit()) :: Cldr.Unit.t() | no_return()

Convert one unit into another unit of the same unit type (length, volume, mass, ...) and raises on a unit type mismatch

Options

Returns

  • a Unit.t of the unit type to_unit or

  • raises an exception

Examples 

iex> Cldr.Unit.Conversion.convert! Cldr.Unit.new!(:celsius, 0), :fahrenheit
#Unit<:fahrenheit, 32.0>

iex> Cldr.Unit.Conversion.convert! Cldr.Unit.new!(:fahrenheit, 32), :celsius
#Unit<:celsius, 0.0>

Cldr.Unit.Conversion.convert Cldr.Unit.new!(:mile, 1), :gallon
** (Cldr.Unit.IncompatibleUnitsError) Operations can only be performed between units of the same type. Received :mile and :gallon
Link to this function

direct_factors() View Source

Link to this function

factors() View Source