View Source Indexed.Managed.Helpers (Indexed v0.3.4)
Some tools for Indexed.Managed.
Link to this section Summary
Types
A 1 or 2-arity function passed to with_index/2.
Functions
Convert a preload shorthand into a predictable data structure.
Given a preload function spec, create a preload function. key is the key of
the parent entity which should be filled with the child or list of children.
Given state, wrapped state, or a module, invoke fun with the
Indexed.t/0. If a module is given, use the index from its __index__/0.
Invoke fun with the managed state, finding it in the :managed key if needed. If fun returns a managed state and it was wrapped, rewrap it.
Link to this section Types
A 1 or 2-arity function passed to with_index/2.
Link to this section Functions
@spec assoc_from_record(record(), atom()) :: record() | nil
@spec build_query(Indexed.Managed.t()) :: Ecto.Queryable.t()
@spec get_managed(state() | module(), atom()) :: Indexed.Managed.t()
Convert a preload shorthand into a predictable data structure.
examples
Examples
iex> normalize_preload(:foo)
[foo: []]
iex> normalize_preload([:foo, bar: :baz])
[foo: [], bar: [baz: []]]@spec preload_fn(assoc_spec(), Ecto.Repo.t()) :: (map(), state() -> any()) | nil
Given a preload function spec, create a preload function. key is the key of
the parent entity which should be filled with the child or list of children.
See t:preload/0.
@spec with_index(Indexed.Managed.state_or_module(), with_index_fun()) :: any()
Given state, wrapped state, or a module, invoke fun with the
Indexed.t/0. If a module is given, use the index from its __index__/0.
@spec with_state(Indexed.Managed.state_or_wrapped(), (state() -> any())) :: any()
Invoke fun with the managed state, finding it in the :managed key if needed. If fun returns a managed state and it was wrapped, rewrap it.