Gcode.Model.Skip (gcode v1.0.2)

A G-code skip.

Summary

error()

t()

init()

Initialise a skip without a number.

init(number)

Initialise a skip with a number.

@type error() :: {:skip_error, String.t()}

@type t() :: %Gcode.Model.Skip{number: Gcode.Option.t(non_neg_integer())}

@spec init() :: Gcode.Result.t(t())

Initialise a skip without a number.

iex> Skip.init()
{:ok, %Skip{number: none()}}

@spec init(non_neg_integer()) :: Gcode.Result.t(t(), error())

Initialise a skip with a number.

iex> 13
...> |> Skip.init()
{:ok, %Skip{number: some(13)}}