gcode v0.4.1

Gcode.Result (gcode v0.4.1)

A helper which represents a result type.

This is really just a wrapper around Erlang's ok/error tuples.

Link to this section Summary

Types

error(error)
ok(result)
t()
t(result)
t(result, error)

Functions

error(error)

Initialise or match an error value

error?(arg)

Is the result an error?

map(arg, mapper)

Convert a successful result another result.

ok(result)

Initialise or match an ok value

ok?(arg)

Is the result ok?

unwrap!(arg)

Attempt to unwrap a result and return the inner value. Raises an exception if the result contains an error.

Link to this section Types

Link to this type

error(error)

Specs

error(error) :: {:error, error}
Link to this type

ok(result)

Specs

ok(result) :: {:ok, result}
Link to this type

t()

Specs

t() :: t(any(), any())
Link to this type

t(result)

Specs

t(result) :: t(result, any())
Link to this type

t(result, error)

Specs

t(result, error) :: ok(result) | error(error)

Link to this section Functions

Link to this macro

error(error)

(macro)

Specs

error(any()) :: Macro.t()

Initialise or match an error value

Link to this function

error?(arg)

Specs

error?(t()) :: boolean()

Is the result an error?

Link to this function

map(arg, mapper)

Specs

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

Convert a successful result another result.

Link to this macro

ok(result)

(macro)

Specs

ok(any()) :: Macro.t()

Initialise or match an ok value

Link to this function

ok?(arg)

Specs

ok?(t()) :: boolean()

Is the result ok?

Link to this function

unwrap!(arg)

Specs

unwrap!(t()) :: any() | no_return()

Attempt to unwrap a result and return the inner value. Raises an exception if the result contains an error.