whitecap_handler (whitecap v0.2.0)

View Source

Summary

Types

header/0
headers/0
status/0
verb/0
whitecap_req/0

Functions

handle(Req, Opts)
handle(Req, Opts, Timeout)
response(Status, Headers)
response(Status, Headers, Body)

Types

header/0

-type header() :: {iodata(), iodata()}.

headers/0

-type headers() :: [header()].

status/0

-type status() :: non_neg_integer() | {non_neg_integer(), iodata()}.

verb/0

-type verb() :: get | head | post | put.

whitecap_req/0

-type whitecap_req() ::
          #whitecap_req{state :: body | done,
                        verb :: verb(),
                        path :: binary(),
                        headers :: [binary()],
                        content_length :: undefined | non_neg_integer(),
                        body :: undefined | binary(),
                        received :: undefined | integer()}.

Functions

handle(Req, Opts)

-spec handle(whitecap_req(), map()) -> {ok, {status(), headers(), iodata()}}.

handle(Req, Opts, Timeout)

-spec handle(whitecap_req(), map(), timeout()) -> {ok, {status(), headers(), iodata()}}.

response(Status, Headers)

-spec response(status(), headers()) -> iodata().

response(Status, Headers, Body)

-spec response(status(), headers(), iodata()) -> iodata().