hex_http behaviour (hex_core v0.15.0)

View Source

HTTP contract.

Summary

Types

adapter_config/0
body/0
headers/0
method/0
status/0

Callbacks

request/5
request_to_file/6

Functions

request(Config, Method, URI, Headers, Body)
request_to_file(Config, Method, URI, Headers, Body, Filename)

Types

adapter_config/0

-type adapter_config() :: map().

body/0

-type body() :: {ContentType :: binary(), Body :: binary()} | undefined.

headers/0

-type headers() :: #{binary() => binary()}.

method/0

-type method() :: get | post | put | patch | delete.

status/0

-type status() :: non_neg_integer().

Callbacks

request/5

-callback request(method(), URI :: binary(), headers(), body(), adapter_config()) ->
                     {ok, {status(), headers(), binary()}} | {error, term()}.

request_to_file/6

-callback request_to_file(method(), URI :: binary(), headers(), body(), file:name_all(), adapter_config()) ->
                             {ok, {status(), headers()}} | {error, term()}.

Functions

request(Config, Method, URI, Headers, Body)

-spec request(hex_core:config(), method(), URI :: binary(), headers(), body()) ->
                 {ok, {status(), headers(), binary()}} | {error, term()}.

request_to_file(Config, Method, URI, Headers, Body, Filename)

-spec request_to_file(hex_core:config(), method(), URI :: binary(), headers(), body(), file:name_all()) ->
                         {ok, {status(), headers()}} | {error, term()}.