Enum ApplyEvent 

pub enum ApplyEvent {
    RunStarted {
        run_id: String,
        writes: usize,
        deletes: usize,
    },
    Staged {
        files: usize,
    },
    LockAcquired {
        hold_s: u64,
    },
    Committed {
        moved: usize,
        deleted: usize,
    },
    LockVerdict {
        held: bool,
    },
    ScanDone,
    VerifyDone {
        ok: bool,
    },
    Finalized,
    CommitInterrupted {
        code: String,
    },
    VerifyChecks {
        checks: Vec<(String, String)>,
    },
    RestoreStarted {
        cause: Option<RollbackCause>,
    },
    LiveChangesDiscarded {
        count: usize,
        paths: Vec<String>,
    },
    Restored,
    Cleared,
    InterruptedRun {
        phase: &'static str,
        action: &'static str,
        hashes: BTreeMap<String, Option<String>>,
    },
    PreflightChecks {
        checks: Vec<(String, String)>,
    },
    DesignersPoll {
        open: usize,
    },
    DesignersProceed {
        sessions: Vec<DesignerSeen>,
    },
    GwbkDownloaded {
        bytes: u64,
    },
    GwbkSkipped,
    BackupSampled {
        last_sync: Option<i64>,
    },
    BackupWaitStarted {
        budget_s: u64,
    },
    BackupPoll {
        peer_connected: bool,
        sync_pending: bool,
        advanced: bool,
    },
    BackupResync {
        ok: bool,
        code: Option<String>,
    },
    BackupVerdict {
        converged: bool,
        reason: Option<&'static str>,
    },
    Failed {
        code: String,
    },
}

One step of a run, value-free: ids, counts and flags only.

Variants

RunStarted

The run directory exists.

Fields

run_id: String

The run.

writes: usize

Files to write.

deletes: usize

Files to delete.

Staged

prepare staged the batch.

Fields

files: usize

Files staged.

LockAcquired

The scan-lock was taken.

Fields

hold_s: u64

Seconds requested.

Committed

commit returned.

Fields

moved: usize

Writes moved.

deleted: usize

Deletes done.

LockVerdict

The lock was judged after the commit.

Fields

held: bool

Whether it was held with the margin left.

ScanDone

The config scan completed.

VerifyDone

deploy_verify answered.

Fields

ok: bool

Whether it was green.

Finalized

The run was finalized.

CommitInterrupted

commit returned an error and this run’s journal is still on the box: what is on the host is unknown and the run is recovered with rollback --run (23-12). Carries the code of the original failure.

Fields

code: String

The error code commit failed with.

VerifyChecks

The checks of a red verdict, by id and status.

Fields

checks: Vec<(String, String)>

(check id, status) in report order.

RestoreStarted

A restore began (23-17). None is a manual rollback (23-11): the closed data.cause vocabulary of an apply is unchanged.

Fields

cause: Option<RollbackCause>

Why an apply is being undone; None for a manual rollback.

LiveChangesDiscarded

A rollback went ahead over live changes made after the run (--discard-live-changes, 23-11): the first paths and the count.

Fields

count: usize

How many touched paths had changed.

paths: Vec<String>

The first crate::error::APPLY_LIST_SHOWN, byte-sorted.

Restored

The restore finished (23-17).

Cleared

A recovery removed an interrupted run that had changed nothing (23-12, D-10).

InterruptedRun

A rollback found that the run it recovers was interrupted (23-12, D-09, D-11): the journal’s phase, what recovery will do and the live hash of each path of the journal’s touched list (None when absent).

Fields

phase: &'static str

The journal’s phase.

action: &'static str

restore or clear.

hashes: BTreeMap<String, Option<String>>

Path to live hash.

PreflightChecks

The preflights found a failed check; every verdict, by id and status.

Fields

checks: Vec<(String, String)>

(check id, status) in report order.

DesignersPoll

The Designer list was read under --designers wait.

Fields

open: usize

Sessions open at this read.

DesignersProceed

--designers proceed went ahead over these open sessions (D-15).

Fields

sessions: Vec<DesignerSeen>

(user, project, host) of each open session.

GwbkDownloaded

The .gwbk was downloaded and read as a ZIP (23-09).

Fields

bytes: u64

Its size in bytes.

GwbkSkipped

--skip-gwbk: no .gwbk was taken (23-09).

BackupSampled

The backup’s sync timestamp was sampled (V3, D-05). Twice per run: after the preflights (the fail-fast read) and again once the lock is held, just before the commit (WR-02); the second is the baseline.

Fields

last_sync: Option<i64>

The backup’s lastSyncTimestamp; None is never synced.

BackupWaitStarted

The wait for the backup began, after the snapshot download (V3).

Fields

budget_s: u64

The budget in seconds.

BackupPoll

One look at the backup’s status (V3).

Fields

peer_connected: bool

The backup sees its peer.

sync_pending: bool

A sync is queued on the backup.

advanced: bool

The backup’s timestamp advanced past its sample.

BackupResync

The one resync request was sent to the master (V3, D-07).

Fields

ok: bool

The POST was accepted.

code: Option<String>

The error code when it was not.

BackupVerdict

The backup phase ended (V3).

Fields

converged: bool

The backup converged.

reason: Option<&'static str>

Why not, when it did not.

Failed

The run failed.

Fields

code: String

The error code slug.

Implementations

impl ApplyEvent

pub fn name(&self) -> &'static str

The event’s name in events.ndjson.

pub fn fields(&self) -> Value

The event’s fields: ids, counts and flags, never a value.

Trait Implementations

impl Clone for ApplyEvent

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 ApplyEvent

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

Formats the value using the given formatter.

impl Eq for ApplyEvent

impl PartialEq for ApplyEvent

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApplyEvent