View Source XHTTP.Response protocol (XHTTP v0.1.0)

The Response protocol provides common functions for retrieving data from a HTTP response.

How exactly that data is retrieved is up to the implementation, and the protocol relies on each response consisting of headers and body.

Summary

body()

header()

header_key()

header_value()

status()

t()

All the types that implement this protocol.

body(response)

Retrieve the last value for a given header.

Checks whether the HTTP response contains the searched header name.

Return an enumerable of headers as {key, value} pairs.

status(response)

Retrieve the body in the Response.

@type body() :: nil | binary() | Enumerable.t() | struct()

@type header_key() :: String.t() | atom()

@type header_value() :: header_value_single() | Enumerable.t(header_value_single())

@type header_value_single() :: String.t() | number() | nil

@type status() :: nil | pos_integer()

@type t() :: term()

All the types that implement this protocol.

@spec body(response :: t()) :: body()

@spec header_member?(response :: t(), header :: String.t()) :: boolean()

Checks whether the HTTP response contains the searched header name.

@spec headers(response :: t()) :: Enumerable.t(header())

Return an enumerable of headers as {key, value} pairs.

@spec status(response :: t()) :: status()

Retrieve the body in the Response.