FunFunc v0.2.0 FunFunc.Result

Functions for result values. The result value is {:ok, x} or {:error, x}.

Link to this section Summary

Types

result()

results()

Functions

collect_errors(results)

Collects only error value

collect_oks(results)

Collects only ok value

error(x)

Creates a error value

error?(result)

Checks the value is a error value

error_or(result, default)

Gets the value in the error result, or gets the default value

error_or_else(result, default)

Gets the value in the error result, or gets the result of the function

flat_map(result, f)

Maps the inside value and flatten if the value is the ok value. Otherwise it returns the value itself

flat_map_error(result, f)

Maps the inside value and flatten if the value is the error value. Otherwise it returns the value itself

join(result, f, g)

If the value is ok, applys the first function. If the value is error, applys the second function. Otherwise returns itself

map(result, f)

Maps the inside value if the value is the ok value. Otherwise it returns the value itself

map_error(result, f)

Maps the inside value if the value is the error value. Otherwise it returns the value itself

ok(x)

Creates a ok value

ok?(result)

Checks the value is a ok value

ok_or(result, default)

Gets the value in the ok result, or gets the default value

ok_or_else(result, default)

Gets the value in the ok result, or gets the result of the function

result?(result)

Checks the value is the ok value or the error value

split(results)

Splits the result list. Non result value is ignored

Link to this section Types

result()

result() :: {atom(), any()}

results()

results() :: [result()]

Link to this section Functions

collect_errors(results)

collect_errors(results()) :: list()

Collects only error value.

iex> FunFunc.Result.collect_errors([{:ok, 1}, {:error, 2}, 3])
[2]

collect_oks(results)

collect_oks(results()) :: list()

Collects only ok value.

iex> FunFunc.Result.collect_oks([{:ok, 1}, {:error, 2}, 3])
[1]

error(x)

error(any()) :: result()

Creates a error value.

Examples

iex> FunFunc.Result.error(1)
{:error, 1}

error?(result)

error?(any()) :: boolean()

Checks the value is a error value.

Examples

iex> FunFunc.Result.error?({:ok, 1})
false
iex> FunFunc.Result.error?({:error, 1})
true
iex> FunFunc.Result.error?(1)
false

error_or(result, default)

error_or(any(), any()) :: any()

Gets the value in the error result, or gets the default value.

iex> FunFunc.Result.error_or({:ok, 1}, 2)
2
iex> FunFunc.Result.error_or({:error, 1}, 2)
1
iex> FunFunc.Result.error_or(1, 2)
2

error_or_else(result, default)

error_or_else(any(), (... -> any())) :: any()

Gets the value in the error result, or gets the result of the function.

iex> FunFunc.Result.error_or_else({:ok, 1}, fn -> 2 end)
2
iex> FunFunc.Result.error_or_else({:error, 1}, fn -> 2 end)
1
iex> FunFunc.Result.error_or_else(1, fn -> 2 end)
2

flat_map(result, f)

flat_map(result(), (... -> any())) :: result()

Maps the inside value and flatten if the value is the ok value. Otherwise it returns the value itself.

Examples

iex> FunFunc.Result.flat_map({:ok, 1}, &{:ok, &1 + 1})
{:ok, 2}
iex> FunFunc.Result.flat_map({:error, 1}, &{:ok, &1 + 1})
{:error, 1}
iex> FunFunc.Result.flat_map(1, &{:ok, &1 + 1})
1

flat_map_error(result, f)

flat_map_error(result(), (... -> any())) :: result()

Maps the inside value and flatten if the value is the error value. Otherwise it returns the value itself.

Examples

iex> FunFunc.Result.flat_map_error({:ok, 1}, &{:error, &1 + 1})
{:ok, 1}
iex> FunFunc.Result.flat_map_error({:error, 1}, &{:error, &1 + 1})
{:error, 2}
iex> FunFunc.Result.flat_map_error(1, &{:ok, &1 + 1})
1

join(result, f, g)

join(result(), (... -> any()), (... -> any())) :: any()

If the value is ok, applys the first function. If the value is error, applys the second function. Otherwise returns itself.

Examples

iex> FunFunc.Result.join({:ok, 1}, &Integer.to_string/1, &Atom.to_string/1)
"1"
iex> FunFunc.Result.join({:error, :atom}, &Integer.to_string/1, &Atom.to_string/1)
"atom"
iex> FunFunc.Result.join(1, &Integer.to_string/1, &Atom.to_string/1)
1

map(result, f)

map(result(), (... -> any())) :: result()

Maps the inside value if the value is the ok value. Otherwise it returns the value itself.

Examples

iex> FunFunc.Result.map({:ok, 1}, &Integer.to_string/1)
{:ok, "1"}
iex> FunFunc.Result.map({:error, 1}, &Integer.to_string/1)
{:error, 1}
iex> FunFunc.Result.map(1, &Integer.to_string/1)
1

map_error(result, f)

map_error(result(), (... -> any())) :: result()

Maps the inside value if the value is the error value. Otherwise it returns the value itself.

Examples

iex> FunFunc.Result.map_error({:ok, 1}, &Integer.to_string/1)
{:ok, 1}
iex> FunFunc.Result.map_error({:error, 1}, &Integer.to_string/1)
{:error, "1"}
iex> FunFunc.Result.map_error(1, &Integer.to_string/1)
1

ok(x)

ok(any()) :: result()

Creates a ok value.

Examples

iex> FunFunc.Result.ok(1)
{:ok, 1}

ok?(result)

ok?(any()) :: boolean()

Checks the value is a ok value.

Examples

iex> FunFunc.Result.ok?({:ok, 1})
true
iex> FunFunc.Result.ok?({:error, 1})
false
iex> FunFunc.Result.ok?(1)
false

ok_or(result, default)

ok_or(any(), any()) :: any()

Gets the value in the ok result, or gets the default value.

iex> FunFunc.Result.ok_or({:ok, 1}, 2)
1
iex> FunFunc.Result.ok_or({:error, 1}, 2)
2
iex> FunFunc.Result.ok_or(1, 2)
2

ok_or_else(result, default)

ok_or_else(any(), (... -> any())) :: any()

Gets the value in the ok result, or gets the result of the function.

iex> FunFunc.Result.ok_or_else({:ok, 1}, fn -> 2 end)
1
iex> FunFunc.Result.ok_or_else({:error, 1}, fn -> 2 end)
2
iex> FunFunc.Result.ok_or_else(1, fn -> 2 end)
2

result?(result)

result?(any()) :: boolean()

Checks the value is the ok value or the error value.

Examples

iex> FunFunc.Result.result?({:ok, 1})
true
iex> FunFunc.Result.result?({:error, 1})
true
iex> FunFunc.Result.result?(1)
false

split(results)

split(results()) :: {list(), list()}

Splits the result list. Non result value is ignored.

iex> FunFunc.Result.split([{:ok, 1}, {:error, 2}, 3])
{[1], [2]}