chaperon v0.1.0 Chaperon.Actionable protocol View Source
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
Functions
Attempts to abort a Chaperon.Actionable
within a Chaperon.Session
and
returns the resulting Chaperon.Actionable
and Chaperon.Session
or a
Chaperon.Action.Error
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
abort_result :: {:ok, Chaperon.Actionable.t, Chaperon.Session.t} | error
Link to this type
error()
View Source
error :: {:error, Chaperon.Action.Error.t} | {:error, Chaperon.Session.Error.t} | {:error, any}
Link to this section Functions
Link to this function
abort(action, session)
View Source
abort(Chaperon.Actionable.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
.
Attempts to run a Chaperon.Actionable
within a Chaperon.Session
and
returns the resulting session or a Chaperon.Action.Error
.