Codex.Files.Registry (Codex SDK v0.14.0)

Copy Markdown View Source

GenServer-backed manifest that tracks staged file attachments, deduplicates by checksum, and prunes expired entries on a schedule. This powers the public Codex.Files helpers.

Summary

Types

stage_opts()
stage_request()
work_item()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

ensure_started()

Ensures the registry is running under application supervision.

force_cleanup()

Triggers an immediate cleanup pass to remove expired attachments.

list()

Lists all staged attachments currently tracked in the manifest.

metrics()

Aggregates counts, sizes, and TTL information for staged attachments.

reset(staging_dir)

Clears the manifest and deletes staged files within the provided staging directory.

stage(opts)

Inserts or refreshes a staged attachment using the supplied options, returning the canonical Attachment struct stored in ETS.

start_link(opts \\ [])

Types

stage_opts()

@type stage_opts() :: %{
  checksum: String.t(),
  name: String.t(),
  persist: boolean(),
  ttl_ms: :infinity | pos_integer(),
  size: non_neg_integer(),
  source_path: Path.t(),
  destination_path: Path.t()
}

stage_request()

@type stage_request() :: {GenServer.from(), stage_opts(), DateTime.t()}

work_item()

@type work_item() ::
  {:stage, String.t(), stage_opts()}
  | {:force_cleanup, GenServer.from(), DateTime.t()}
  | {:cleanup_tick, DateTime.t()}
  | {:reset, GenServer.from(), Path.t()}
  | :cleanup_orphaned_staging

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

ensure_started()

@spec ensure_started() :: {:ok, pid()} | {:error, term()}

Ensures the registry is running under application supervision.

force_cleanup()

@spec force_cleanup() :: :ok | {:error, term()}

Triggers an immediate cleanup pass to remove expired attachments.

list()

@spec list() :: [Codex.Files.Attachment.t()]

Lists all staged attachments currently tracked in the manifest.

metrics()

@spec metrics() :: map()

Aggregates counts, sizes, and TTL information for staged attachments.

reset(staging_dir)

@spec reset(Path.t()) :: :ok | {:error, term()}

Clears the manifest and deletes staged files within the provided staging directory.

stage(opts)

@spec stage(stage_opts()) :: {:ok, Codex.Files.Attachment.t()} | {:error, term()}

Inserts or refreshes a staged attachment using the supplied options, returning the canonical Attachment struct stored in ETS.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()