LibTmux.Error exception (libtmux v0.0.1-alpha.1)

Copy Markdown View Source

An inspectable failure with its phase and certainty about effects.

retryable describes a recovery option; it never authorizes replay of a mutation. Diagnostic details must stay within the producing operation's byte budget. Bang functions raise this same structure.

Summary

Types

certainty()

Evidence about effects, independent of whether cleanup or arbitrary program completion is proved.

path_component()

A field, array index or observed identity locating an error; links retain their contextual tuple ID.

t()

A structured API failure. Kind and phase are extensible; retryable never permits automatic mutation replay.

Types

certainty()

@type certainty() :: :no_write | :acknowledged | :observed | :unknown

Evidence about effects, independent of whether cleanup or arbitrary program completion is proved.

path_component()

@type path_component() :: atom() | non_neg_integer() | LibTmux.Ref.id()

A field, array index or observed identity locating an error; links retain their contextual tuple ID.

t()

@type t() :: %LibTmux.Error{
  __exception__: term(),
  certainty: certainty(),
  details: map(),
  kind: atom(),
  path: [path_component()],
  phase: atom(),
  retryable: boolean()
}

A structured API failure. Kind and phase are extensible; retryable never permits automatic mutation replay.