ExPersona.Client.Result (ex_persona v0.0.2) View Source

This module is used to represent the result of an API call.

It is passed to the parser specified in a given ExPersona.Client.Operation and the result is what's returned from an ExPersona.Client.request/1.

Link to this section Summary

t()

Convert the raw results of an API call and turn them into a ExPersona.Client.Result.

t() :: %ExPersona.Client.Result{
  body: binary(),
  operation: ExPersona.Client.Operation.t(),
  parsed: map() | nil
}

from_encoded(String.t(), list(), ExPersona.Client.Operation.t()) :: t()

Convert the raw results of an API call and turn them into a ExPersona.Client.Result.

to_streamable(t()) :: ExPersona.Client.Streamable.t()

This is used in cases where we expect the result to contain pagination.