View Source Antikythera.Session (antikythera v0.5.1)

Definition of data structure to work with session.

Gear implementations usually don't use the functions defined in this module; instead use

Summary

Types

t()

Functions

clear(session)
data(session)

Type-aware getter for data.

data(s, field)

Type-aware setter for data.

delete(session, key)
destroy(session)
get(arg0, key)
id(session)

Type-aware getter for id.

id(s, field)

Type-aware setter for id.

new(dict)

Creates a new instance of Antikythera.Session by using the given dict.

new!(dict)

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

put(session, key, value)
renew(session)
state(session)

Type-aware getter for state.

state(s, field)

Type-aware setter for state.

update(s, dict)

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

update!(s, dict)

A variant of update/2 which returns t or raise if validation fails. In other words, update/2 followed by Croma.Result.get!/1.

valid?(value)

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

Types

Link to this type

t()

View Source 
@type t() :: %Antikythera.Session{
  data: Croma.Map.t(),
  id: Croma.TypeGen.Nilable.Croma.String.t(),
  state: Antikythera.Session.State.t()
}

Functions

Link to this function

clear(session)

View Source 
@spec clear(t()) :: t()
Link to this function

data(session)

View Source 
@spec data(t()) :: Croma.Map.t()

Type-aware getter for data.

Link to this function

data(s, field)

View Source 
@spec data(t(), Croma.Map.t()) :: t()

Type-aware setter for data.

Link to this function

delete(session, key)

View Source 
@spec delete(t(), String.t()) :: t()
Link to this function

destroy(session)

View Source 
@spec destroy(t()) :: t()
Link to this function

get(arg0, key)

View Source 
@spec get(t(), String.t()) :: any()
Link to this function

id(session)

View Source 
@spec id(t()) :: Croma.TypeGen.Nilable.Croma.String.t()

Type-aware getter for id.

Link to this function

id(s, field)

View Source 
@spec id(t(), Croma.TypeGen.Nilable.Croma.String.t()) :: t()

Type-aware setter for id.

Link to this function

new(dict)

View Source 
@spec new(term()) :: Croma.Result.t(t())

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
Link to this function

new!(dict)

View Source 
@spec new!(term()) :: t()

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 
@spec put(t(), String.t(), any()) :: t()
Link to this function

renew(session)

View Source 
@spec renew(t()) :: t()
Link to this function

state(session)

View Source 
@spec state(t()) :: Antikythera.Session.State.t()

Type-aware getter for state.

Link to this function

state(s, field)

View Source 
@spec state(t(), Antikythera.Session.State.t()) :: t()

Type-aware setter for state.

Link to this function

update(s, dict)

View Source 
@spec update(t(), Dict.t()) :: Croma.Result.t(t())

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 
@spec 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.

Link to this function

valid?(value)

View Source 
@spec valid?(term()) :: boolean()

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