Enum WalError 

pub enum WalError {
    Io(Error),
    Corruption {
        offset: u64,
        path: PathBuf,
        detail: String,
    },
    SequenceSkip {
        expected: u64,
        got: u64,
    },
    Full {
        count: usize,
        limit: usize,
    },
    UnsupportedVersion {
        path: PathBuf,
        detail: String,
    },
    InvalidHeader {
        path: PathBuf,
        detail: String,
    },
    PayloadTooLarge {
        size: usize,
        limit: usize,
    },
    LockPoisoned(String),
    Poisoned,
}

Write-Ahead Log errors.

Variants

Io(Error)

Underlying I/O error.

Corruption

Data corruption detected (CRC mismatch).

Fields

offset: u64

Byte offset in the WAL file where corruption was detected.

path: PathBuf

Path to the corrupted WAL file.

detail: String

Human-readable detail about the corruption.

SequenceSkip

Sequence number discontinuity detected during replay.

Fields

expected: u64

The expected next sequence number.

got: u64

The actual sequence number encountered.

Full

WAL is full — too many unflushed WAL files.

Fields

count: usize

Current number of unflushed WAL files.

limit: usize

Maximum allowed unflushed WAL files.

UnsupportedVersion

The log belongs to a different on-disk format generation.

Distinct from Corruption and from InvalidHeader: the header is well formed, the bytes are intact, and the reader is from another generation — so the remedy is to match the versions up rather than to restore. All four durable formats classify this the same way; see chronix_engine::format.

Fields

path: PathBuf

Path to the WAL file.

detail: String

What was read, what this build expects, and what to do.

InvalidHeader

Invalid WAL file header (wrong magic bytes).

Fields

path: PathBuf

Path to the WAL file with the invalid header.

detail: String

Description of what’s wrong with the header.

PayloadTooLarge

Payload exceeds the maximum allowed size per WAL record.

Fields

size: usize

Actual payload size in bytes.

limit: usize

Maximum allowed payload size in bytes.

LockPoisoned(String)

Internal lock was poisoned (indicates a prior panic while holding the lock).

Poisoned

The WAL writer’s file is in an unknown state after a failed fsync or a failed rewind, and every write is refused until the database is reopened.

The message names reopening, not clear_poison(). It named the latter for a long time, and no user of the chronix facade can call it: it is a chronix-engine method the facade does not re-export. An error that tells the operator to do something they cannot do is worse than one that says nothing.

Trait Implementations

impl Debug for WalError

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

Formats the value using the given formatter.

impl Display for WalError

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

Formats the value using the given formatter.

impl Error for WalError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for WalError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<WalError> for ChronixError

fn from(source: WalError) -> Self

Converts to this type from the input type.