Pike.Store behaviour (pike v0.3.0)

Behaviour module defining the interface for Pike API key stores.

Any module used as a store in Pike must implement these functions.

Summary

Checks if the given key struct permits the specified action on a resource.

delete_key(t)

Optional: Deletes a key from the store.

get_key(t)

insert(map)

Inserts a key into the store. Used primarily for in-memory stores like ETS.

Optional: Updates a key in the store.

@callback action?(map(), resource :: String.t(), action :: atom()) :: boolean()

Checks if the given key struct permits the specified action on a resource.

(optional)

@callback delete_key(String.t()) :: :ok | {:error, term()}

Optional: Deletes a key from the store.

@callback get_key(String.t()) :: {:ok, map()} | :error

@callback insert(map()) :: :ok | {:error, term()}

Inserts a key into the store. Used primarily for in-memory stores like ETS.

(optional)

@callback update_key(String.t(), map()) :: :ok | {:error, term()}

Optional: Updates a key in the store.