hex_core v0.10.0

View Source hex_http behaviour (hex_core v0.10.0)

HTTP contract.

Link to this section Summary

Types

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

Callbacks

request/5

Functions

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

Link to this section Types

Link to this type

body/0

View Source 
-type body() :: {ContentType :: binary(), Body :: binary()} | undefined.
Link to this type

headers/0

View Source 
-type headers() :: #{binary() => binary()}.
Link to this type

method/0

View Source 
-type method() :: get | post | put | patch | delete.
Link to this type

status/0

View Source 
-type status() :: non_neg_integer().

Link to this section Callbacks

Link to this callback

request/5

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

Link to this section Functions

Link to this function

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

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