View Source X3m.System.Response (X3m System v0.8.5)

Summary

Types

@type t() ::
  :ok
  | {:ok, any()}
  | {:ok, any(), integer()}
  | {:created, any()}
  | {:created, any(), integer()}
  | {:service_unavailable, atom()}
  | {:service_timeout, atom(), String.t(), non_neg_integer()}
  | {:validation_error, map()}
  | {:missing_id, atom() | String.t()}
  | {:error, any()}

Functions

@spec created(any()) :: {:created, any()}
@spec error(any()) :: {:error, any()}
@spec missing_id(atom() | String.t()) :: {:missing_id, atom() | String.t()}
@spec ok() :: :ok
@spec ok(any()) :: {:ok, any()}
Link to this function

service_timeout(msg_name, req_id, timeout)

View Source
@spec service_timeout(atom(), String.t(), non_neg_integer()) ::
  {:service_timeout, atom(), String.t(), non_neg_integer()}
Link to this function

service_unavailable(msg_name)

View Source
@spec service_unavailable(atom()) :: {:service_unavailable, atom()}
@spec unauthorized(String.t()) :: {:unauthorized, String.t()}
Link to this function

validation_error(request)

View Source
@spec validation_error(map()) :: {:validation_error, map()}