antikythera v0.4.0 Antikythera.Http.SetCookie View Source
Link to this section Summary
Functions
Type-aware getter for domain.
Type-aware setter for domain.
Type-aware getter for http_only.
Type-aware setter for http_only.
Type-aware getter for max_age.
Type-aware setter for max_age.
Creates a new instance of Antikythera.Http.SetCookie by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Type-aware getter for path.
Type-aware setter for path.
Type-aware getter for secure.
Type-aware setter for secure.
Updates an existing instance of Antikythera.Http.SetCookie 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.
Type-aware getter for value.
Type-aware setter for value.
Link to this section Types
Specs
options_t() :: %{
optional(:path) => Antikythera.EncodedPath.t(),
optional(:domain) => Antikythera.Domain.t(),
optional(:secure) => boolean(),
optional(:http_only) => boolean(),
optional(:max_age) => non_neg_integer()
}
Specs
t() :: %Antikythera.Http.SetCookie{
domain: Croma.TypeGen.Nilable.Antikythera.Domain.t(),
http_only: Croma.TypeGen.Nilable.Croma.Boolean.t(),
max_age: Croma.TypeGen.Nilable.Croma.Integer.t(),
path: Croma.TypeGen.Nilable.Antikythera.EncodedPath.t(),
secure: Croma.TypeGen.Nilable.Croma.Boolean.t(),
value: Croma.String.t()
}
Link to this section Functions
Specs
domain(t()) :: Croma.TypeGen.Nilable.Antikythera.Domain.t()
Type-aware getter for domain.
Specs
Type-aware setter for domain.
Specs
http_only(t()) :: Croma.TypeGen.Nilable.Croma.Boolean.t()
Type-aware getter for http_only.
Specs
Type-aware setter for http_only.
Specs
max_age(t()) :: Croma.TypeGen.Nilable.Croma.Integer.t()
Type-aware getter for max_age.
Specs
Type-aware setter for max_age.
Specs
new(term()) :: Croma.Result.t(t())
Creates a new instance of Antikythera.Http.SetCookie 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/0of each field typenew/1of 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
Specs
path(t()) :: Croma.TypeGen.Nilable.Antikythera.EncodedPath.t()
Type-aware getter for path.
Specs
Type-aware setter for path.
Specs
secure(t()) :: Croma.TypeGen.Nilable.Croma.Boolean.t()
Type-aware getter for secure.
Specs
Type-aware setter for secure.
Specs
update(t(), Dict.t()) :: Croma.Result.t(t())
Updates an existing instance of Antikythera.Http.SetCookie 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.
Specs
value(t()) :: Croma.String.t()
Type-aware getter for value.
Specs
value(t(), Croma.String.t()) :: t()
Type-aware setter for value.