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

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

Link to this section Functions

Link to this function clear(session) View Source
clear(t()) :: t()

Type-aware getter for data.

Link to this function data(s, field) View Source
data(t(), Croma.Map.t()) :: t()

Type-aware setter for data.

Link to this function destroy(session) View Source
destroy(t()) :: t()

Type-aware getter for id.

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/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 put(session, key, value) View Source
put(Antikythera.Session.t(), String.t(), any()) :: t()
Link to this function renew(session) View Source
renew(t()) :: 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}.

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.