Enum EnvironmentFailureReason 

pub enum EnvironmentFailureReason {
    LogChecksum,
    LogWrite,
    LogFileNotFound,
    LogIntegrity,
    BtreeCorruption,
    UnexpectedState,
    UnexpectedStateFatal,
    UnexpectedException,
    UnexpectedExceptionFatal,
    DiskLimit,
    LatchTimeout,
    ThreadInterrupted,
    MasterToReplicaTransition,
    ReplicaFencing,
    HandshakeError,
    ProtocolVersionMismatch,
    UncaughtException,
    ForcedShutdown,
    RecoveryFailure,
    Other(String),
}

Distinguishes the root cause of an EnvironmentFailure.

Callers can match on this to decide whether to attempt restart (invalidates_environment = false) or give up (invalidates_environment = true).

Variants

LogChecksum

A checksum mismatch was detected in the log (persistent corruption). isCorrupted() == true. : LOG_CHECKSUM.

LogWrite

A log write I/O error occurred. : LOG_WRITE.

LogFileNotFound

A log file was not found during read (truncation or deletion). Mirrors LOG_FILE_NOT_FOUND.

LogIntegrity

The log is incomplete or internally inconsistent. Mirrors LOG_INTEGRITY.

BtreeCorruption

A persistent B-tree structure inconsistency was detected. isCorrupted() == true. : BTREE_CORRUPTION.

UnexpectedState

An unexpected internal state was reached (non-fatal; env still valid). Mirrors UNEXPECTED_STATE.

UnexpectedStateFatal

An unexpected internal state was reached (fatal; env is invalidated). Mirrors UNEXPECTED_STATE_FATAL.

UnexpectedException

An unexpected exception was caught internally (non-fatal). Mirrors UNEXPECTED_EXCEPTION.

UnexpectedExceptionFatal

An unexpected exception was caught internally (fatal; env invalidated). Mirrors UNEXPECTED_EXCEPTION_FATAL.

DiskLimit

The disk limit (MAX_DISK) or free-disk threshold (FREE_DISK) was exceeded. : DISK_LIMIT.

LatchTimeout

A latch acquisition timed out. : LATCH_TIMEOUT.

ThreadInterrupted

The calling thread was interrupted while performing a Mirrors THREAD_INTERRUPTED.

MasterToReplicaTransition

The master transitioned to a replica while a transaction was active. Mirrors MASTER_TO_REPLICA_TRANSITION.

ReplicaFencing

The replica was fenced by the master. Mirrors REPLICA_FENCING.

HandshakeError

A replication handshake error occurred. Mirrors HANDSHAKE_ERROR.

ProtocolVersionMismatch

Replication protocol version mismatch. Mirrors PROTOCOL_VERSION_MISMATCH.

UncaughtException

An uncaught exception in a background replication thread. Mirrors UNCAUGHT_EXCEPTION.

ForcedShutdown

Forced shutdown was requested. Mirrors FORCED_SHUTDOWN.

RecoveryFailure

Recovery (WAL replay during environment open) failed.

The v1.5.0 layer surfaced every recovery failure as UnexpectedState, which forced callers to string-match the prefix “recovery failed:” to distinguish it from other unexpected-state errors. This variant is now produced specifically when WAL replay aborts the open path; if invalidates_environment returns true the environment is unusable and a fresh open is required.

Other(String)

The specific reason is not mapped to a named variant.

Implementations

impl EnvironmentFailureReason

pub fn invalidates_environment(&self) -> bool

Returns true if this reason causes the environment to be invalidated.

After an invalidating failure, all open Environment handles become unusable; they must be closed and re-opened to run recovery.

Mirrors EnvironmentFailureReason.invalidatesEnvironment().

pub fn is_corrupted(&self) -> bool

Returns true if the environment log is persistently corrupted, meaning a network restore or backup restore may be required.

Mirrors EnvironmentFailureException.isCorrupted().

Trait Implementations

impl Clone for EnvironmentFailureReason

fn clone(&self) -> EnvironmentFailureReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentFailureReason

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

Formats the value using the given formatter.

impl Display for EnvironmentFailureReason

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

Formats the value using the given formatter.

impl Eq for EnvironmentFailureReason

impl PartialEq for EnvironmentFailureReason

fn eq(&self, other: &EnvironmentFailureReason) -> 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 EnvironmentFailureReason