foil (foil v0.1.4)

View Source

Summary

Types

error/0
error_reason/0
key/0
namespace/0
value/0

Functions

all(Namespace)
delete(Namespace)
delete(Namespace, Key)
insert(Namespace, Key, Value)
load(Namespace)
lookup(Namespace, Key)
new(Namespace)

Types

error/0

-type error() :: {error, error_reason()}.

error_reason/0

-type error_reason() :: foil_not_started | key_not_found | module_exists | module_not_found.

key/0

-type key() :: term().

namespace/0

-type namespace() :: atom().

value/0

-type value() :: term().

Functions

all(Namespace)

-spec all(namespace()) -> {ok, #{key() := value()}} | error().

delete(Namespace)

-spec delete(namespace()) -> ok | error().

delete(Namespace, Key)

-spec delete(namespace(), key()) -> ok | error().

insert(Namespace, Key, Value)

-spec insert(namespace(), key(), value()) -> ok | error().

load(Namespace)

-spec load(namespace()) -> ok | error().

lookup(Namespace, Key)

-spec lookup(namespace(), key()) -> {ok, value()} | error().

new(Namespace)

-spec new(namespace()) -> ok | error().