Elasticlunr v0.6.6

Elasticlunr.IndexManager (Elasticlunr v0.6.6) View Source

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get(name)
init(index)

Callback implementation for GenServer.init/1.

loaded?(name)
loaded_indices()
preload()
remove(index)
save(index)
start_link(index)
update(index)
via(name)

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Specs

child_spec(Elasticlunr.Index.t()) :: map()

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get(name)

View Source

Specs

get(binary()) :: Elasticlunr.Index.t() | :not_running
Link to this function

init(index)

View Source

Specs

init(Elasticlunr.Index.t()) :: {:ok, Elasticlunr.Index.t()}

Callback implementation for GenServer.init/1.

Link to this function

loaded?(name)

View Source

Specs

loaded?(binary()) :: boolean()
Link to this function

loaded_indices()

View Source

Specs

loaded_indices() :: [binary()]
Link to this function

preload()

View Source

Specs

preload() :: :ok
Link to this function

remove(index)

View Source

Specs

remove(Elasticlunr.Index.t()) :: :ok | :not_running
Link to this function

save(index)

View Source

Specs

save(Elasticlunr.Index.t()) :: {:ok, Elasticlunr.Index.t()} | {:error, any()}
Link to this function

start_link(index)

View Source

Specs

start_link(Elasticlunr.Index.t()) :: :ignore | {:error, any()} | {:ok, pid()}
Link to this function

update(index)

View Source

Specs

update(Elasticlunr.Index.t()) :: Elasticlunr.Index.t() | :not_running
Link to this function

via(name)

View Source

Specs

via(binary()) :: {:via, Registry, {Elasticlunr.IndexRegistry, atom()}}