Serum.Result (serum v1.5.1) View Source
This module defines types for positive results or errors returned by functions in this project.
Link to this section Summary
Functions
Takes a list of results without value and checks if there is no error.
Takes a list of results with values and checks if there is no error.
Gets a human friendly message from the given result.
Prints an error object in a beautiful format.
Link to this section Types
Specs
err_details() :: msg_detail() | full_detail() | nest_detail()
Specs
error() :: {:error, err_details()}
Specs
full_detail() :: {binary(), binary(), non_neg_integer()}
Specs
msg_detail() :: binary()
Specs
Specs
t() :: :ok | error()
Specs
t(type) :: {:ok, type} | error()
Link to this section Functions
Specs
Takes a list of results without value and checks if there is no error.
Returns :ok if there is no error.
Returns an aggregated error object if there is one or more errors.
Specs
Takes a list of results with values and checks if there is no error.
If there is no error, it returns {:ok, list} where list is a list of
returned values.
Returns an aggregated error object if there is one or more errors.
Specs
get_message(t() | t(term()), non_neg_integer()) :: binary()
Gets a human friendly message from the given result.
You can control the indentation level by passing a non-negative integer to
the depth parameter.
Specs
show(t() | t(term()), non_neg_integer()) :: :ok
Prints an error object in a beautiful format.