View Source Solid.Context (solid v0.17.1)

Summary

Types

scope()

t()

Functions

get_in(context, key, scopes)

Get data from context respecting the scope order provided.

put_errors(context, errors)

run_cycle(context, cycle)

Find the current value that cycle must return

Types

scope()

@type scope() :: :counter_vars | :vars | :iteration_vars

t()

@type t() :: %Solid.Context{
  counter_vars: map(),
  cycle_state: map(),
  errors: [Solid.UndefinedVariableError],
  iteration_vars: %{optional(String.t()) => term()},
  matcher_module: module(),
  vars: map()
}

Functions

get_in(context, key, scopes)

@spec get_in(t(), [term()], [scope()]) ::
  {:ok, term()} | {:error, {:not_found, [term()]}}

Get data from context respecting the scope order provided.

Possible scope values: :counter_vars, :vars or :iteration_vars

put_errors(context, errors)

run_cycle(context, cycle)

@spec run_cycle(
  t(),
  [{:values, [String.t()]}] | [name: String.t(), values: [String.t()]]
) ::
  {t(), String.t()}

Find the current value that cycle must return