Struct BatchSpec 

pub struct BatchSpec {
    pub run_id: RunId,
    pub gateway: String,
    pub mode: String,
    pub writes: Vec<WriteOp>,
    pub deletes: Vec<DeleteOp>,
    pub ledger_new: Option<Vec<u8>>,
    pub ledger_pre: Option<String>,
    pub journal: Journal,
    pub record: RunRecord,
    pub commit_budget_s: Option<u32>,
}

Everything one prepare and commit need, decided by the engine.

writes and deletes are byte-sorted and unique and disjoint. The journal and record are the run’s documents as the engine wants them; the host sets the journal phase itself at each step.

Fields

run_id: RunId

The run.

gateway: String

The target gateway directory name.

mode: String

The target mode collection.

writes: Vec<WriteOp>

The files to write.

deletes: Vec<DeleteOp>

The files to delete.

ledger_new: Option<Vec<u8>>

The new ledger bytes (already validated with Ledger::parse), swapped last. None leaves the ledger alone.

ledger_pre: Option<String>

The live ledger hash the plan was made against; None when there is no ledger yet.

journal: Journal

The journal of this run.

record: RunRecord

The run record at state applying.

commit_budget_s: Option<u32>

The seconds, from the start of the commit, within which the moves and deletes must be done: the scan-lock hold less its margin. A host stops before the next move, delete or retry once it is spent and reports BatchReport::deadline. None sets no limit.

Implementations

impl BatchSpec

pub fn touched_paths(&self) -> Vec<String>

The paths this run touches, byte-sorted: every write, every delete and LEDGER_KEY when the ledger is swapped.

pub fn problem(&self) -> Option<String>

The first thing wrong with this spec, or None. A host calls this before any I/O; the engine builds a valid spec, so a problem here is a defect, reported value-free.

pub fn journal_at(&self, phase: JournalPhase) -> Journal

The journal of this run at phase.

Trait Implementations

impl Clone for BatchSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.