antikythera v0.2.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

Link to this type options_t() View Source
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()}
Link to this type t() View Source
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

Link to this function domain(set_cookie) View Source
domain(t()) :: Croma.TypeGen.Nilable.Antikythera.Domain.t()

Type-aware getter for domain.

Link to this function domain(s, field) View Source
domain(t(), Croma.TypeGen.Nilable.Antikythera.Domain.t()) :: t()

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.

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

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

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

Link to this function path(set_cookie) View Source
path(t()) :: Croma.TypeGen.Nilable.Antikythera.EncodedPath.t()

Type-aware getter for path.

Link to this function path(s, field) View Source
path(t(), Croma.TypeGen.Nilable.Antikythera.EncodedPath.t()) :: t()

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}.

Link to this function update!(s, dict) View Source
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.

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

Type-aware getter for value.

Link to this function value(s, field) View Source
value(t(), Croma.String.t()) :: t()

Type-aware setter for value.