Ecbolic

v0.2.4

Ecbolic v0.2.4 Ecbolic.Store View Source

This GenServer is responsible for storing all functions and the related help-data.

Link to this section Summary

Types

help()

An entry used by Ecbolic.Store to store information about a function and related help-data

Functions

all()

Returns all stored help entries

all_grouped()

Returns all stored help entries, but mapped to their group

child_spec(arg)

Returns a specification to start this module under a supervisor

clear_store()

Clears the internal state of the store

group(group)

Returns all help entries for a given group. An empty list will be returned, if the group does not exist

group_names()

Returns a list of all group names

load(module)

Loads help from the given function

lookup(functions)

Returns the help entry for the asked action

Link to this section Types

Link to this type help() View Source 
help() :: %Ecbolic.Help{
  help: String.t(),
  help_alias: Ecbolic.atom_or_string(),
  help_group: Ecbolic.atom_or_string()
}

An entry used by Ecbolic.Store to store information about a function and related help-data

Link to this section Functions

Link to this function all() View Source 
all() :: [help()]

Returns all stored help entries

Link to this function all_grouped() View Source 
all_grouped() :: {:ok, %{optional(Ecbolic.atom_or_string()) => [help()]}}

Returns all stored help entries, but mapped to their group

Link to this function child_spec(arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function clear_store() View Source 
clear_store() :: :ok

Clears the internal state of the store.

This is neccessary if you want to reload the entries. If you try to do so, without calling this function first, you’ll have duplicated entries.

Link to this function group(group) View Source 
group(Ecbolic.atom_or_string()) :: [help()]

Returns all help entries for a given group. An empty list will be returned, if the group does not exist.

Note: Ungrouped functions are given the :default-group

Link to this function group_names() View Source 
group_names() :: [Ecbolic.atom_or_string()]

Returns a list of all group names.

Link to this function load(module) View Source 
load(atom()) :: :ok

Loads help from the given function.

Link to this function lookup(functions) View Source 
lookup([Ecbolic.atom_or_string()]) :: {:ok, [help()]}
lookup([Ecbolic.atom_or_string()]) :: {:ok, [help()]} | {:error, String.t()}

Returns the help entry for the asked action.