Skip to content

vox-journal API Reference (generated)

Crate: vox-journal · Version: 0.6.0 · Target: Library (lib.rs)

Generic append-only JSON Lines file journal for Vox. Crash-safe via per-record sync_data; replays on open. Used as the durable substrate by vox-workflow-runtime, vox-actor-runtime, and the mobile-shipped vox-runtime-rn (via uniffi).

Generic append-only JSON Lines file journal.

Stores a sequence of serde-serializable entries one per line in a file. Crash-safe by default ([AppendDurability::SyncEachAppend]): every successful append call flushes + sync_datas the handle so the bytes are on the device before the call returns. Mobile profiles open with [AppendDurability::Deferred] instead and make the bytes durable on the OS lifecycle hook (Suspendable::suspend → [FileJournal::sync]). On open, the existing file is fully read and parsed entries are returned to the caller for replay.

Designed as the mobile-portable durability substrate underneath:

  • vox-workflow-runtime::FileJournalTracker (real WorkflowTracker impl)
  • vox-actor-runtime actor state checkpointing (future)
  • vox-runtime-rn::open_file_journal (uniffi-exported for JS)

This crate has zero dependencies on vox-db, the workspace-hack crate, or any other host-only build infrastructure. It cross-compiles cleanly to every Android + iOS architecture.

DependencyKind
vox-runtimeNormal
Dependency Topology, diagram 15 nodes, 4 edges: vox-journal → vox-runtime; vox-runtime-rn → vox-journal; vox-terminal-core → vox-journal; vox-workflow-runtime → vox-journalvox-journalvox-runtimevox-runtime-rnvox-terminal-corevox-workflow-runtime
Diagram source
graph {
direction: right
node vox_journal: "vox-journal"
node vox_runtime: "vox-runtime"
vox_journal -> vox_runtime
node vox_runtime_rn: "vox-runtime-rn"
vox_runtime_rn -> vox_journal
node vox_terminal_core: "vox-terminal-core"
vox_terminal_core -> vox_journal
node vox_workflow_runtime: "vox-workflow-runtime"
vox_workflow_runtime -> vox_journal
}
Consumer CrateRole
vox-runtime-rnDirect workspace dependent
vox-terminal-coreDirect workspace dependent
vox-workflow-runtimeDirect workspace dependent