CliSubprocessCore.Payload.Error (CliSubprocessCore v0.1.0)

Represents a normalized runtime error.

Summary

Types

severity()

t()

Functions

new(attrs \\ [])

parse(payload)

parse!(payload)

schema()

to_map(payload)

Types

severity()

@type severity() :: :info | :warning | :error | :fatal

t()

@type t() :: %CliSubprocessCore.Payload.Error{
  code: String.t() | nil,
  extra: map(),
  message: String.t(),
  metadata: map(),
  severity: severity()
}

Functions

new(attrs \\ [])

@spec new(keyword() | map() | struct()) :: struct()

parse(payload)

@spec parse(keyword() | map() | struct()) ::
  {:ok, struct()}
  | {:error,
     {:invalid_payload, module(), CliSubprocessCore.Schema.error_detail()}}

parse!(payload)

@spec parse!(keyword() | map() | struct()) :: struct()

schema()

@spec schema() :: Zoi.schema()

to_map(payload)

@spec to_map(struct()) :: map()