want v1.1.1 Want.Float

Performs type conversions to float values.

Link to this section Summary

Functions

Cast a value to a float.

Callback implementation for Want.Type.cast/2.

Link to this section Types

Link to this type

result()

result() :: {:ok, float()} | {:error, binary()}

Link to this section Functions

Link to this function

cast(value)

cast(value :: any()) :: result()

Cast a value to a float.

Options

  • :max - Maximum allowable float value.
  • :min - Minimum allowable float value.

Examples

iex> Want.Float.cast("1")

iex> Want.Float.cast(1.0)

iex> Want.Float.cast(:'1')

iex> Want.Float.cast({:a, :b}) {:error, "Failed to convert value {:a, :b} to float."}

iex> Want.Float.cast("10", max: 3.0)

iex> Want.Float.cast(1.0, min: 3.0)

Link to this function

cast(value, opts)

cast(value :: any(), opts :: Keyword.t()) :: result()

Callback implementation for Want.Type.cast/2.