DarkMatter.Decimals.cast_decimal_ok

You're seeing just the function cast_decimal_ok, go back to DarkMatter.Decimals module for more information.

Specs

cast_decimal_ok(any()) :: {:ok, Decimal.t()} | :error

Casts an x of type DarkMatter.numeric/0 into a Decimal.t/0.

Returns {:ok, %Decimal{}} or :error

Examples

iex> cast_decimal_ok(0.11)
{:ok, %Decimal{coef: 11, exp: -2}}

iex> cast_decimal_ok(nil)
:error

iex> cast_decimal_ok(1_000, :normal)
{:ok, %Decimal{coef: 1_000, exp: 0}}

iex> cast_decimal_ok(1_000, :reduced)
{:ok, %Decimal{coef: 1, exp: 3}}
Link to this function

cast_decimal_ok(x, mode)

View Source

Specs

cast_decimal_ok(any(), DarkMatter.Decimals.Conversion.conversion_modes()) ::
  {:ok, Decimal.t()} | :error

See DarkMatter.Decimals.Conversion.cast_decimal_ok/2.