Instream v2.2.1

View Source Instream.HTTPClient behaviour (Instream v2.2.1)

Behaviour definition for switchable HTTP clients.

Link to this section Summary

Types

method()
response()

Callbacks

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

Link to this section Types

Link to this type

method()

View Source 
@type method() :: :get | :head | :post
Link to this type

response()

View Source 
@type response() ::
  {:ok, status :: pos_integer(), headers :: list()}
  | {:ok, status :: pos_integer(), headers :: list(), body :: binary()}
  | {:error, term()}

Link to this section Callbacks

Link to this callback

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

View Source 
@callback request(
  method :: method(),
  url :: binary(),
  headers :: list(),
  body :: binary(),
  opts :: list()
) :: response()