Wardrik.Error exception (wardrik_protocol v0.1.0-rc.6)

An operation's failure, as the protocol's error.

%Wardrik.Error{type: :not_found, message: "No agent agt_1."}

type is one of type/0. message is for people to read.

Summary

t()

type()

json(error)

Returns error as the protocol's JSON error body.

Returns an error of type with message.

@type t() :: %Wardrik.Error{__exception__: term(), message: String.t(), type: type()}

@type type() ::
  :invalid_request
  | :unauthorized
  | :forbidden
  | :not_found
  | :conflict
  | :not_supported
  | :unavailable
  | :internal

@spec json(t()) :: map()

Returns error as the protocol's JSON error body.

Wardrik.Error.json(Wardrik.Error.new(:not_found, "No agent agt_1."))
#=> %{"error" => %{"type" => "not_found", "message" => "No agent agt_1."}}

@spec new(type(), String.t()) :: t()

Returns an error of type with message.