antikythera v0.3.0 Antikythera.Request View Source

Updates an existing instance of Antikythera.Request with the given dict. The values in the dict are validated by each field's valid?/1 function. Returns {:ok, valid_struct} or {:error, reason}.

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

Checks if the given value belongs to t/0 or not.

Link to this section Types

t()

t() :: %Antikythera.Request{
  body: Antikythera.Http.Body.t(),
  cookies: Antikythera.Http.ReqCookiesMap.t(),
  headers: Antikythera.Http.Headers.t(),
  method: Antikythera.Http.Method.t(),
  path_info: Antikythera.PathInfo.t(),
  path_matches: Antikythera.Request.PathMatches.t(),
  query_params: Antikythera.Http.QueryParams.t(),
  raw_body: Antikythera.Http.RawBody.t(),
  sender: Antikythera.Request.Sender.t()
}

Link to this section Functions

body(request)

body(t()) :: Antikythera.Http.Body.t()

Type-aware getter for body.

body(s, field)

body(t(), Antikythera.Http.Body.t()) :: t()

Type-aware setter for body.

cookies(request)

cookies(t()) :: Antikythera.Http.ReqCookiesMap.t()

Type-aware getter for cookies.

cookies(s, field)

cookies(t(), Antikythera.Http.ReqCookiesMap.t()) :: t()

Type-aware setter for cookies.

headers(request)

headers(t()) :: Antikythera.Http.Headers.t()

Type-aware getter for headers.

headers(s, field)

headers(t(), Antikythera.Http.Headers.t()) :: t()

Type-aware setter for headers.

method(request)

method(t()) :: Antikythera.Http.Method.t()

Type-aware getter for method.

method(s, field)

method(t(), Antikythera.Http.Method.t()) :: t()

Type-aware setter for method.

new(dict)

new(term()) :: Croma.Result.t(t())

Creates a new instance of Antikythera.Request by using the given dict.

Returns {:ok, valid_struct} or {:error, reason}.

The values in the dict are validated by each field's valid?/1 function. If the value was invalid, it will be passed to new/1 of the field

For missing fields, followings will be tried:

default/0 of each field type
new/1 of each field type, with empty map as input

new!(dict)

new!(term()) :: t()

A variant of new/1 which returns t or raise if validation fails.

In other words, new/1 followed by Croma.Result.get!/1.

path_info(request)

path_info(t()) :: Antikythera.PathInfo.t()

Type-aware getter for path_info.

path_info(s, field)

path_info(t(), Antikythera.PathInfo.t()) :: t()

Type-aware setter for path_info.

path_matches(request)

path_matches(t()) :: Antikythera.Request.PathMatches.t()

Type-aware getter for path_matches.

path_matches(s, field)

path_matches(t(), Antikythera.Request.PathMatches.t()) :: t()

Type-aware setter for path_matches.

query_params(request)

query_params(t()) :: Antikythera.Http.QueryParams.t()

Type-aware getter for query_params.

query_params(s, field)

query_params(t(), Antikythera.Http.QueryParams.t()) :: t()

Type-aware setter for query_params.

raw_body(request)

raw_body(t()) :: Antikythera.Http.RawBody.t()

Type-aware getter for raw_body.

raw_body(s, field)

raw_body(t(), Antikythera.Http.RawBody.t()) :: t()

Type-aware setter for raw_body.

sender(request)

sender(t()) :: Antikythera.Request.Sender.t()

Type-aware getter for sender.

sender(s, field)

sender(t(), Antikythera.Request.Sender.t()) :: t()

Type-aware setter for sender.

update(s, dict)

update(t(), Dict.t()) :: Croma.Result.t(t())

update!(s, dict)

update!(t(), Dict.t()) :: t()

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

valid?(term()) :: boolean()

Checks if the given value belongs to t/0 or not.