IndieWeb.Cache.Adapter behaviour (IndieWeb v0.0.66) View Source

Interface presenting the adapter for caching values.

This provides the interface that adapters should implement if they'd like IndieWeb to use it for caching values. Check IndieWeb for more information and IndieWeb.Cache.Adapters.Cachex for more information.

Link to this section Summary

Callbacks

delete(key)

Defines the method of deleting a cached value.

get(key, default_value)

Defines the method for obtaining a cached value.

set(key, value, options)

Defines the method of setting of a cached value.

Link to this section Callbacks

delete(key)

Specs

delete(key :: binary()) :: :ok | :error

Defines the method of deleting a cached value.

get(key, default_value)

Specs

get(key :: binary(), default_value :: any()) :: {:ok, any()} | {:error, any()}

Defines the method for obtaining a cached value.

set(key, value, options)

Specs

set(key :: binary(), value :: any(), options :: keyword()) :: :ok | :error

Defines the method of setting of a cached value.