ExGitEngine.Cache behaviour (ex_git_engine v0.9.0)

Behaviour for caching Git operations.

Summary

cache()

cache_entry()

cache_key()

op()

Fetches the value for a specific cache_key.

Initialize the cache for the given path.

Returns the cache key for the given op or nil if the operation should not be cached.

Puts the given cache_entry under cache_key.

@type cache() :: term()

@type cache_entry() :: term()

@type cache_key() :: term()

@type op() :: atom() | tuple()

@callback fetch_cache(cache(), cache_key()) :: cache_entry() | nil

Fetches the value for a specific cache_key.

@callback init_cache(path :: Path.t(), opts :: keyword()) :: cache()

Initialize the cache for the given path.

@callback make_cache_key(op()) :: cache_key() | nil

Returns the cache key for the given op or nil if the operation should not be cached.

@callback put_cache(cache(), cache_key(), cache_entry()) :: :ok

Puts the given cache_entry under cache_key.