Metastatic.Cache behaviour (Metastatic v0.33.0)

AST Caching behaviour and dispatcher for Metastatic.

Caches the results of parsing and abstracting source code to MetaAST (M2).

Backends

The backend is selected with config :metastatic, :cache, backend:

:ets (default) — Metastatic.Cache.ETS, in-memory, always available.
:dllb — Metastatic.Cache.DLLB, opt-in; requires the host application to provide the Dllb module and set config :dllb, :enabled, true.
any module implementing the Metastatic.Cache behaviour.

The default is deliberately :ets rather than environment sniffing: a library should not silently change behaviour based on what happens to be loaded in the host VM.

Summary

Callbacks

clear()

get(adapter, source)

init()

put(adapter, source, meta_ast, metadata)

Functions

clear()

Clear all cached entries from the active cache backend.

get(adapter, source)

Get cached abstraction result (MetaAST + Metadata) for a source code string and language.

impl()

Return the configured cache implementation module.

init()

Initialize the active cache backend. Called automatically during application startup.

put(adapter, source, meta_ast, metadata)

Store abstraction result in cache.

Callbacks

clear()

@callback clear() :: :ok

get(adapter, source)

@callback get(adapter :: module(), source :: String.t()) ::
  {:ok, term(), map()} | {:error, :not_found}

init()

@callback init() :: :ok

put(adapter, source, meta_ast, metadata)

@callback put(
  adapter :: module(),
  source :: String.t(),
  meta_ast :: term(),
  metadata :: map()
) :: :ok

Functions

clear()

@spec clear() :: :ok

Clear all cached entries from the active cache backend.

get(adapter, source)

@spec get(module(), String.t()) :: {:ok, term(), map()} | {:error, :not_found}

Get cached abstraction result (MetaAST + Metadata) for a source code string and language.

impl()

@spec impl() :: module()

Return the configured cache implementation module.

Options for :metastatic, :cache are:

:ets (default) -> Metastatic.Cache.ETS
:dllb -> Metastatic.Cache.DLLB
A module implementing Metastatic.Cache

init()

@spec init() :: :ok

Initialize the active cache backend. Called automatically during application startup.

put(adapter, source, meta_ast, metadata)

@spec put(module(), String.t(), term(), map()) :: :ok

Store abstraction result in cache.