Stellar.Horizon.Client.Spec behaviour (Elixir Stellar SDK v0.5.0) View Source

Specifies expected behaviour of an HTTP client.

Stellar allows you to use your HTTP client of choice, provided that it can be coerced into complying with this module's specification. The default is :hackney.

Link to this section Summary

Link to this section Types

Specs

body() :: binary()

Specs

headers() :: [{binary(), binary()}, ...]

Specs

method() :: :get | :post | :put | :delete

Specs

options() :: Keyword.t()

Specs

response() :: {:ok, status(), headers()}

Specs

response_error() :: {:error, any()}

Specs

response_with_body() :: {:ok, status(), headers(), body()}

Specs

status() :: non_neg_integer()

Link to this section Callbacks

Link to this callback

request(method, url, body, headers, options)

View Source

Specs

request(
  method :: method(),
  url :: binary(),
  body :: binary(),
  headers :: headers(),
  options :: options()
) :: response() | response_with_body() | response_error()