Searchex v0.0.1 Shake.Frame
Defines a struct that is passed up and down the Shake build chain.
defstruct cfg_snip: "",
cfg_name: "",
params: %{},
catalog: %{},
index: %{},
query: "",
scores: [],
results: %{},
tgt_id: nil,
tgt_doc: %{},
halted: false,
halt_msg: "",
digests: %{},
assigns: %{}
Summary
Functions
Assigns a value to a key in the frame
Retrieve the digest from the frame
Halts the Shake job by preventing downstream steps
from being invoked. Optional halt_msg
can be a
String or list of Strings
Assign a digest to a key in the frame
Types
Functions
Assigns a value to a key in the frame
Examples
iex> frame.assigns[:hello]
nil
iex> frame = assign(frame, :hello, :world)
iex> frame.assigns[:hello]
:world
Halts the Shake job by preventing downstream steps
from being invoked. Optional halt_msg
can be a
String or list of Strings.