Cldr Units v2.0.0 Cldr.Unit.Conversion View Source
Unit conversion functions for the units defined
in Cldr
.
Link to this section Summary
Functions
Convert one unit into another unit of the same unit type (length, volume, mass, …)
Link to this section Functions
Link to this function
convert(unit, to_unit)
View Source
convert(Cldr.Unit.t(), Cldr.Unit.unit()) :: Cldr.Unit.t()
Convert one unit into another unit of the same unit type (length, volume, mass, …)
Options
unit
is any unit returned byCldr.Unit.new/2
to_unit
is any unit name returned byCldr.Unit.units/0
Returns
a
Unit.t
of the unit typeto_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.IncompatibleUnitError,
"Operations can only be performed between units of the same type. Received :mile and :gallon"}}