vox-journal API Reference (generated)
vox-journal
Section titled “vox-journal”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).
Crate Overview
Section titled “Crate Overview”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(realWorkflowTrackerimpl)vox-actor-runtimeactor 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.
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-runtime | Normal |