Enum RecoveryPolicy 

#[non_exhaustive]
pub enum RecoveryPolicy {
    StopAtFirstError,
    SkipBadRecords,
}

How Wal::iter reacts to a damaged record.

This governs iteration, not the torn-tail truncation that Wal::open always performs to keep the append boundary clean. It matters when a record in the middle of an already-recovered log is damaged — bit rot, say — and you are reading the log back.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StopAtFirstError

Stop at the first damaged record: yield it as a single WalError::Corruption, then end.

The default, and the right choice for an append-only log, where a damaged record means everything after it is untrustworthy.

SkipBadRecords

Skip past a damaged record and keep going, for forensic or partial recovery.

Each damaged record is still yielded as a WalError::Corruption — the loss is never silent — but iteration then resumes at the next record. This is only possible while a damaged record’s length prefix is intact enough to locate the next one; a record whose length itself is unreadable (a short read, or a length past the maximum) still stops iteration, because there is no way to know where the following record begins.

Trait Implementations

impl Clone for RecoveryPolicy

fn clone(&self) -> RecoveryPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RecoveryPolicy

impl Debug for RecoveryPolicy

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

Formats the value using the given formatter.

impl Eq for RecoveryPolicy

impl PartialEq for RecoveryPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RecoveryPolicy