estructura
estructura v0.4.2

View Source Estructura.Lazy (estructura v0.4.2)

The field stub allowing lazy instantiation of Estructura fields.

Link to this section Summary

Types

cached()
getter()
key()
t()
value()

Functions

apply(lazy, lazy_data, key \\ nil)

Apply the lazy getter to the data passed as an argument

new(getter, expires_in \\ :never)

Create the new struct with the getter passed as an argument

stale?(lazy)

Validates if the value is not stale yet according to expires_in setting

Link to this section Types

Link to this type

cached()

View Source 
@type cached() :: {:ok, value()} | {:error, any()}
Link to this type

getter()

View Source 
@type getter() :: (value() -> cached()) | (key(), value() -> cached())
Link to this type

key()

View Source 
@type key() :: Map.key()
Link to this type

t()

View Source 
@type t() :: %Estructura.Lazy{
  expires_in: non_neg_integer() | :instantly | :never,
  timestamp: nil | DateTime.t(),
  payload: any(),
  value: cached(),
  getter: getter()
}
Link to this type

value()

View Source 
@type value() :: Map.value()

Link to this section Functions

Link to this function

apply(lazy, lazy_data, key \\ nil)

View Source 
@spec apply(t(), %{__lazy_data__: term()} | term(), key()) :: t()

Apply the lazy getter to the data passed as an argument

examples

 Examples 

iex> lazy = Estructura.Lazy.new(&System.fetch_env/1)
...> Estructura.Lazy.apply(lazy, "LANG").value
System.fetch_env("LANG")
Link to this function

new(getter, expires_in \\ :never)

View Source 
@spec new(getter(), non_neg_integer() | :instantly | :never) :: t()

Create the new struct with the getter passed as an argument

Link to this function

stale?(lazy)

View Source 
@spec stale?(t()) :: boolean()

Validates if the value is not stale yet according to expires_in setting