Rustic.Result (Rustic.Result v0.6.0) View Source

Documentation for RusticResult.

Link to this section Summary

Types

err()

Describe an Err value

f()

A function that maps a value to a result

ok()

Describe an Ok value

t()

Describe a Result type

Functions

and_then(err, func)

Apply a function which returns a result to an Ok result, or propagates the error.

collect(enumerable)

Iterate over Results, will fail at the first Error result.

err(reason)

Wraps a value into an Err result

filter_collect(enumerable)

Iterate over Results, will ignore failed items.

flatten(arg1)

Flatten a result containing another result.

is_err?(arg1)

Returns true if the Result is an Err value

is_err_result(val)

Is valid if and only if an Err result is supplied

is_ok?(arg1)

Returns true if the Result is an Ok value

is_ok_result(val)

Is valid if and only if an Ok result is supplied

map(err, func)

Apply a function to the value contained in an Ok result, or propagates the error.

map_err(arg1, func)

Apply a function to the value contained in an Err result, or propagates the Ok result.

ok(v)

Wraps a value into an Ok result

or_else(ok, func)

Apply a function which returns a result to an Err result, or propagates the Ok value.

partition_collect(enumerable)

Iterate over Results, returns a tuple of

unwrap!(arg1)

Unwrap an Ok result, or raise an exception

unwrap_err!(arg1)

Unwrap an Err result, or raise an exception

unwrap_or(arg1, default)

Unwrap an Ok result, or return a default value

Link to this section Types

err()

Specs

err() :: {:error, term()}

Describe an Err value

f()

Specs

f() :: (any() -> t())

A function that maps a value to a result

ok()

Specs

ok() :: :ok | {:ok, any()}

Describe an Ok value

t()

Specs

t() :: ok() | err()

Describe a Result type

Link to this section Functions

and_then(err, func)

Specs

and_then(t(), f()) :: t()

Apply a function which returns a result to an Ok result, or propagates the error.

collect(enumerable)

Specs

collect(Enumerable.t(t())) :: t()

Iterate over Results, will fail at the first Error result.

err(reason)

Specs

err(term()) :: err()

Wraps a value into an Err result

filter_collect(enumerable)

Specs

filter_collect(Enumerable.t(t())) :: ok()

Iterate over Results, will ignore failed items.

flatten(arg1)

Specs

flatten(t()) :: t()

Flatten a result containing another result.

is_err?(arg1)

Specs

is_err?(t()) :: boolean()

Returns true if the Result is an Err value

is_err_result(val)

(macro)

Is valid if and only if an Err result is supplied

is_ok?(arg1)

Specs

is_ok?(t()) :: boolean()

Returns true if the Result is an Ok value

is_ok_result(val)

(macro)

Is valid if and only if an Ok result is supplied

map(err, func)

Specs

map(t(), (any() -> any())) :: t()

Apply a function to the value contained in an Ok result, or propagates the error.

map_err(arg1, func)

Specs

map_err(t(), (any() -> any())) :: t()

Apply a function to the value contained in an Err result, or propagates the Ok result.

ok(v)

Specs

ok(any()) :: ok()

Wraps a value into an Ok result

or_else(ok, func)

Specs

or_else(t(), f()) :: t()

Apply a function which returns a result to an Err result, or propagates the Ok value.

partition_collect(enumerable)

Specs

partition_collect(Enumerable.t(t())) :: {ok(), err()}

Iterate over Results, returns a tuple of:

Ok result containing the list of Ok values
Err result containing the list of Err reasons

unwrap!(arg1)

Specs

unwrap!(t()) :: any()

Unwrap an Ok result, or raise an exception

unwrap_err!(arg1)

Specs

unwrap_err!(t()) :: term()

Unwrap an Err result, or raise an exception

unwrap_or(arg1, default)

Specs

unwrap_or(t(), any()) :: any()

Unwrap an Ok result, or return a default value