View Source Want.Float (want v1.17.1)

Performs type conversions to float values.

Summary

Functions

Cast a value to a float.

Callback implementation for Want.Type.cast/2.

Types

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

Functions

@spec 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")
{:ok, 1.0}

iex> Want.Float.cast(1.0)
{:ok, 1.0}

iex> Want.Float.cast(:'1')
{:ok, 1.0}

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

iex> Want.Float.cast("10", max: 3.0)
{:error, "Float value exceeds maximum 3.0."}

iex> Want.Float.cast(1.0, min: 3.0)
{:error, "Float value below minimum 3.0."}
@spec cast(value :: any(), opts :: Keyword.t()) :: result()

Callback implementation for Want.Type.cast/2.