antikythera v0.3.0 Antikythera.Session View Source
Definition of data structure to work with session.
Gear implementations usually don't use the functions defined in this module; instead use
Antikythera.Plug.Session- interfaces in
Antikythera.Conn(e.g.Antikythera.Conn.get_session/2).
Link to this section Summary
Functions
Type-aware getter for data.
Type-aware setter for data.
Type-aware getter for id.
Type-aware setter for id.
Creates a new instance of Antikythera.Session by using the given dict.
A variant of new/1 which returns t or raise if validation fails.
Type-aware getter for state.
Type-aware setter for state.
Updates an existing instance of Antikythera.Session 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
t()
View Sourcet() :: %Antikythera.Session{
data: Croma.Map.t(),
id: Croma.TypeGen.Nilable.Croma.String.t(),
state: Antikythera.Session.State.t()
}
Link to this section Functions
Type-aware getter for data.
Type-aware setter for data.
delete(session, key)
View Sourcedelete(Antikythera.Session.t(), String.t()) :: t()
Type-aware getter for id.
id(s, field)
View Sourceid(t(), Croma.TypeGen.Nilable.Croma.String.t()) :: t()
Type-aware setter for id.
Creates a new instance of Antikythera.Session 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
A variant of new/1 which returns t or raise if validation fails.
In other words, new/1 followed by Croma.Result.get!/1.
put(session, key, value)
View Sourceput(Antikythera.Session.t(), String.t(), any()) :: t()
Type-aware getter for state.
Type-aware setter for state.
Updates an existing instance of Antikythera.Session 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.