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

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

@type body() :: binary()
@type headers() :: [{binary(), binary()}, ...]
@type method() :: :get | :post | :put | :delete
@type options() :: Keyword.t()
@type response() :: {:ok, status(), headers()}
@type response_error() :: {:error, any()}
@type response_with_body() :: {:ok, status(), headers(), body()}
@type status() :: non_neg_integer()

Link to this section Callbacks

Link to this callback

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

View Source
@callback request(
  method :: method(),
  url :: binary(),
  body :: binary(),
  headers :: headers(),
  options :: options()
) :: response() | response_with_body() | response_error()