Jidoka.Memory.Store behaviour (Jidoka v0.9.0)

Behaviour and delegator for agent memory stores.

Summary

Types

store()

Callbacks

list_entries(keyword)

Lists entries available to the store.

recall(t, keyword)

Recalls memory entries for a normalized request.

write(t, keyword)

Persists one normalized memory write.

Functions

list_entries(store)

Lists entries through a store module or configured store tuple.

recall(store, request)

Recalls entries through a store module or configured store tuple.

write(store, request)

Writes an entry through a store module or configured store tuple.

Types

store()

@type store() :: module() | {module(), keyword()}

Callbacks

list_entries(keyword)

@callback list_entries(keyword()) :: {:ok, [Jidoka.Memory.Entry.t()]} | {:error, term()}

Lists entries available to the store.

recall(t, keyword)

@callback recall(
  Jidoka.Memory.RecallRequest.t(),
  keyword()
) :: {:ok, Jidoka.Memory.RecallResult.t()} | {:error, term()}

Recalls memory entries for a normalized request.

write(t, keyword)

@callback write(
  Jidoka.Memory.WriteRequest.t(),
  keyword()
) :: {:ok, Jidoka.Memory.WriteResult.t()} | {:error, term()}

Persists one normalized memory write.

Functions

list_entries(store)

@spec list_entries(store()) :: {:ok, [Jidoka.Memory.Entry.t()]} | {:error, term()}

Lists entries through a store module or configured store tuple.

recall(store, request)

@spec recall(store(), Jidoka.Memory.RecallRequest.t()) ::
  {:ok, Jidoka.Memory.RecallResult.t()} | {:error, term()}

Recalls entries through a store module or configured store tuple.

write(store, request)

@spec write(store(), Jidoka.Memory.WriteRequest.t()) ::
  {:ok, Jidoka.Memory.WriteResult.t()} | {:error, term()}

Writes an entry through a store module or configured store tuple.