ankh v0.8.6 Ankh.HTTP.Request

Ankh HTTP Request

Link to this section Summary

Types

Request method

HTTP request options

Request path

t()

HTTP Request

Link to this section Types

Specs

method() ::
  :CONNECT | :DELETE | :GET | :HEAD | :OPTIONS | :PATCH | :POST | :PUT | :TRACE

Request method

Specs

options() :: Keyword.t()

HTTP request options

Specs

path() :: String.t()

Request path

Specs

t() :: %Ankh.HTTP.Request{
  body: Ankh.HTTP.body() | nil,
  headers: Ankh.HTTP.headers(),
  method: method(),
  options: options(),
  path: path(),
  trailers: term()
}

HTTP Request

Link to this section Functions

Specs

from_uri(URI.t()) :: t()
Link to this function

new(attrs \\ [])

Specs

new(keyword()) :: t()
Link to this function

put_header(request, header, value)

Specs

put_header(t(), Ankh.HTTP.header_name(), Ankh.HTTP.header_value()) :: t()
Link to this function

put_headers(request, headers)

Specs

put_headers(t(), Ankh.HTTP.headers()) :: t()
Link to this function

put_options(request, new_options)

Specs

put_options(t(), options()) :: t()
Link to this function

put_path(request, path)

Specs

put_path(t(), path()) :: t()
Link to this function

put_query(request, query)

Specs

put_query(t(), Enum.t()) :: t()
Link to this function

put_trailer(request, header, value)

Specs

put_trailer(t(), Ankh.HTTP.header_name(), Ankh.HTTP.header_value()) :: t()
Link to this function

put_trailers(request, trailers)

Specs

put_trailers(t(), Ankh.HTTP.headers()) :: t()
Link to this function

put_uri(request, uri)

Specs

put_uri(t(), URI.t()) :: t()
Link to this function

set_body(request, body)

Specs

set_body(t(), iodata()) :: t()
Link to this function

set_method(request, method)

Specs

set_method(t(), method()) :: t()
Link to this function

set_path(request, path)

Specs

set_path(t(), path()) :: t()
Link to this function

set_query(request, query)

Specs

set_query(t(), Enum.t()) :: t()

Specs

to_uri(t()) :: URI.t()