ankh v0.8.0 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

Link to this type

method()

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

Request method

Link to this type

options()

options() :: Keyword.t()

HTTP request options

Link to this type

path()

path() :: String.t()

Request path

Link to this type

t()

t() :: %Ankh.HTTP.Request{
  body: Ankh.HTTP.body() | nil,
  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

from_uri(uri)

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

new(attrs \\ [])

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

put_header(request, header, value)

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

put_options(request, new_options)

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

put_path(request, path)

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

put_query(request, query)

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

put_trailer(request, trailer, value)

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

put_uri(request, uri)

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

set_body(request, body)

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

set_method(request, method)

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

set_path(request, path)

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

set_query(request, query)

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

to_uri(map)

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