Arc.QueryResult (cratis_arc v0.1.0)

Copy Markdown View Source

The outcome of executing a query, shaped as the Arc query result envelope.

Summary

Types

t()

Functions

status(r)

The HTTP status the Arc contract maps this result to.

success?(r)

Whether the query was ready, authorized, valid and free of exceptions.

to_wire(r)

Converts the result to the wire envelope.

Types

t()

@type t() :: %Arc.QueryResult{
  authorized?: term(),
  correlation_id: term(),
  data: term(),
  exception_messages: term(),
  exception_stack_trace: term(),
  paging: term(),
  ready?: term(),
  validation_results: term()
}

Functions

status(r)

@spec status(t()) :: 200 | 202 | 400 | 403 | 500

The HTTP status the Arc contract maps this result to.

success?(r)

@spec success?(t()) :: boolean()

Whether the query was ready, authorized, valid and free of exceptions.

to_wire(r)

@spec to_wire(t()) :: map()

Converts the result to the wire envelope.