antikythera v0.4.0 Antikythera.Request View Source
Definition of Antikythera.Request
struct.
Link to this section Summary
Functions
Type-aware getter for body.
Type-aware setter for body.
Type-aware getter for cookies.
Type-aware setter for cookies.
Type-aware getter for headers.
Type-aware setter for headers.
Type-aware getter for method.
Type-aware setter for method.
Creates a new instance of Antikythera.Request by using the given dict
.
A variant of new/1
which returns t
or raise if validation fails.
Type-aware getter for path_info.
Type-aware setter for path_info.
Type-aware getter for path_matches.
Type-aware setter for path_matches.
Type-aware getter for query_params.
Type-aware setter for query_params.
Type-aware getter for raw_body.
Type-aware setter for raw_body.
Type-aware getter for sender.
Type-aware setter for sender.
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}
.
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
.
Checks if the given value belongs to t/0
or not.
Link to this section Types
Specs
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
Specs
body(t()) :: Antikythera.Http.Body.t()
Type-aware getter for body.
Specs
body(t(), Antikythera.Http.Body.t()) :: t()
Type-aware setter for body.
Specs
cookies(t()) :: Antikythera.Http.ReqCookiesMap.t()
Type-aware getter for cookies.
Specs
cookies(t(), Antikythera.Http.ReqCookiesMap.t()) :: t()
Type-aware setter for cookies.
Specs
headers(t()) :: Antikythera.Http.Headers.t()
Type-aware getter for headers.
Specs
headers(t(), Antikythera.Http.Headers.t()) :: t()
Type-aware setter for headers.
Specs
method(t()) :: Antikythera.Http.Method.t()
Type-aware getter for method.
Specs
method(t(), Antikythera.Http.Method.t()) :: t()
Type-aware setter for method.
Specs
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 typenew/1
of each field type, with empty map as input
Specs
A variant of new/1
which returns t
or raise if validation fails.
In other words, new/1
followed by Croma.Result.get!/1
.
Specs
path_info(t()) :: Antikythera.PathInfo.t()
Type-aware getter for path_info.
Specs
path_info(t(), Antikythera.PathInfo.t()) :: t()
Type-aware setter for path_info.
Specs
path_matches(t()) :: Antikythera.Request.PathMatches.t()
Type-aware getter for path_matches.
Specs
path_matches(t(), Antikythera.Request.PathMatches.t()) :: t()
Type-aware setter for path_matches.
Specs
query_params(t()) :: Antikythera.Http.QueryParams.t()
Type-aware getter for query_params.
Specs
query_params(t(), Antikythera.Http.QueryParams.t()) :: t()
Type-aware setter for query_params.
Specs
raw_body(t()) :: Antikythera.Http.RawBody.t()
Type-aware getter for raw_body.
Specs
raw_body(t(), Antikythera.Http.RawBody.t()) :: t()
Type-aware setter for raw_body.
Specs
sender(t()) :: Antikythera.Request.Sender.t()
Type-aware getter for sender.
Specs
sender(t(), Antikythera.Request.Sender.t()) :: t()
Type-aware setter for sender.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
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}
.
Specs
A variant of update/2
which returns t
or raise if validation fails.
In other words, update/2
followed by Croma.Result.get!/1
.
Specs
Checks if the given value belongs to t/0
or not.