Ankh.HTTP.Request (ankh v0.14.5)
Ankh HTTP Request
Link to this section Summary
Functions
See Ankh.HTTP.fetch_header_values/2
.
See Ankh.HTTP.fetch_trailer_values/2
.
See Ankh.HTTP.put_header/3
.
See Ankh.HTTP.put_headers/2
.
See Ankh.HTTP.put_trailer/3
.
See Ankh.HTTP.put_trailers/2
.
See Ankh.HTTP.validate_body/1
.
Link to this section Types
Link to this type
method()
Specs
method() :: :CONNECT | :DELETE | :GET | :HEAD | :OPTIONS | :PATCH | :POST | :PUT | :TRACE
Request method
Link to this type
options()
Specs
options() :: keyword()
HTTP request options
Link to this type
path()
Specs
path() :: String.t()
Request path
Link to this type
query()
Specs
query() :: Enum.t()
Request query
Specs
t() :: %Ankh.HTTP.Request{ body: Ankh.HTTP.body(), headers: Ankh.HTTP.headers(), method: method(), options: options(), path: path(), trailers: Ankh.HTTP.headers() }
HTTP Request
Link to this section Functions
Link to this function
fetch_header_values(request, header)
Specs
fetch_header_values(t(), Ankh.HTTP.header_name()) :: [Ankh.HTTP.header_value()]
See Ankh.HTTP.fetch_header_values/2
.
Link to this function
fetch_trailer_values(request, trailer)
Specs
fetch_trailer_values(t(), Ankh.HTTP.header_name()) :: [Ankh.HTTP.header_value()]
See Ankh.HTTP.fetch_trailer_values/2
.
Link to this function
from_uri(uri)
Specs
Link to this function
new(attrs \\ [])
Specs
Link to this function
put_header(request, name, value)
Specs
put_header(t(), Ankh.HTTP.header_name(), Ankh.HTTP.header_value()) :: t()
See Ankh.HTTP.put_header/3
.
Link to this function
put_headers(request, headers)
Specs
put_headers(t(), Ankh.HTTP.headers()) :: t()
See Ankh.HTTP.put_headers/2
.
Link to this function
put_options(request, new_options)
Specs
Link to this function
put_path(request, path)
Specs
Link to this function
put_query(request, query)
Specs
Link to this function
put_trailer(request, name, value)
Specs
put_trailer(t(), Ankh.HTTP.header_name(), Ankh.HTTP.header_value()) :: t()
See Ankh.HTTP.put_trailer/3
.
Link to this function
put_trailers(request, trailers)
Specs
put_trailers(t(), Ankh.HTTP.headers()) :: t()
See Ankh.HTTP.put_trailers/2
.
Link to this function
put_uri(request, uri)
Specs
Link to this function
set_body(request, body)
Specs
Link to this function
set_method(request, method)
Specs
Link to this function
set_path(request, path)
Specs
Link to this function
set_query(request, query)
Specs
Link to this function
to_uri(map)
Specs
Link to this function
validate_body(request)
Specs
See Ankh.HTTP.validate_body/1
.
Link to this function
validate_headers(headers, strict, forbidden \\ [])
Specs
validate_headers(Ankh.HTTP.headers(), boolean(), [Ankh.HTTP.header_name()]) :: :ok | {:error, :protocol_error}