chaperon v0.3.1

View Source Chaperon.Actionable protocol (chaperon v0.3.1)

Protocol implemented by all valid measurable actions that can be performed in a Chaperon.Session. All Actions implementing this protocol are found within the Chaperon.Action module.

Link to this section Summary

Types

abort_result()
error()
result()
t()

Functions

abort(action, session)

Attempts to abort a Chaperon.Actionable within a Chaperon.Session and returns the resulting Chaperon.Actionable and Chaperon.Session or a Chaperon.Action.Error.

run(action, session)

Attempts to run a Chaperon.Actionable within a Chaperon.Session and returns the resulting session or a Chaperon.Action.Error.

Link to this section Types

Link to this type

abort_result()

View Source 
@type abort_result() :: {:ok, t(), Chaperon.Session.t()} | error()
Link to this type

error()

View Source 
@type error() ::
  {:error, Chaperon.Action.Error.t()}
  | {:error, Chaperon.Session.Error.t()}
  | {:error, any()}
Link to this type

result()

View Source 
@type result() :: {:ok, Chaperon.Session.t()} | error()
Link to this type

t()

View Source 
@type t() :: term()

Link to this section Functions

Link to this function

abort(action, session)

View Source 
@spec abort(t(), Chaperon.Session.t()) :: abort_result()

Attempts to abort a Chaperon.Actionable within a Chaperon.Session and returns the resulting Chaperon.Actionable and Chaperon.Session or a Chaperon.Action.Error.

Link to this function

run(action, session)

View Source 
@spec run(t(), Chaperon.Session.t()) :: result()

Attempts to run a Chaperon.Actionable within a Chaperon.Session and returns the resulting session or a Chaperon.Action.Error.