View Source Stellar.Horizon.Client.Spec behaviour (Elixir Stellar SDK v0.22.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.

Summary

Types

body()

headers()

method()

options()

response()

response_error()

response_with_body()

server()

status()

Callbacks

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

Types

body()

@type body() :: binary()

headers()

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

method()

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

options()

@type options() :: Keyword.t()

response()

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

response_error()

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

response_with_body()

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

server()

@type server() :: Stellar.Horizon.Server.t()

status()

@type status() :: non_neg_integer()

Callbacks

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

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