API Reference Raxol Journal v#2.8.0

Copy Markdown View Source

Modules

The typed event contract between the agent core and any surface (CLI, TUI, LiveView, remote): the event envelope (Raxol.Agent.Contract.Event), its JSON line encoder, and the decoder for the evidence marker a closing turn_completed carries.

The contract envelope. One struct per observable step; id is a per-run monotonic sequence (the future journal offset).

Behaviour for a session's durable append-only journal — the source of truth for the durable tier of events (see the package README, "The journal").

The hash chain of a chain: true journal (schema_version 1.2.0).

File-backed Raxol.Agent.Journal — one directory per session, the directory is the session (portable, tar-able, rsync-able, grep-able).

Tolerant replay of a session's JSONL journal segments (see the package README, "The journal").

The single-writer GenServer for one session's journal (see the package README, "The journal").

Checkpoint pointer records.

The file-store backend for Raxol.Agent.Journal.Records.Checkpoint. Implements the checkpoint pointer-record discipline over a Raxol.Agent.Journal.FileStore session.

The FROZEN conversational-tip predicate — the single contract implementation of conversational?/1 and tip/2.

Raxol.Journal.* names for the modules of this package.

Alias of Raxol.Agent.Contract.Event. The struct is %Raxol.Agent.Contract.Event{}.

Fault-injection harness for ExUnit suites that exercise the journal.

A second BEAM OS process with every application built beside raxol_journal on its path, for tests of the journal's cross-process writer lock: a holder that is really another BEAM.

The anchor check of a mutation-control checklist: the line a control tells a reader to mutate must still exist verbatim in the source.