Enum Error 

#[non_exhaustive]
pub enum Error {
    Io {
        context: &'static str,
        source: Error,
    },
    Corruption {
        reason: &'static str,
    },
}

Available on crate feature std only.

Everything that can go wrong while opening, reading from, writing to, or flushing an Lsm engine.

The type is #[non_exhaustive]: future versions may add variants without a major bump, so a match over it must include a wildcard arm.

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.

Io

An underlying I/O operation failed.

context names the operation that was attempted (for example "open database directory" or "flush memtable to disk") so the message is actionable without a backtrace. The original io::Error is preserved as the source; inspect it when the OS error kind (disk full, permission denied, not found) drives the recovery decision.

Fields

context: &'static str

What the engine was trying to do when the I/O error occurred.

source: Error

The underlying operating-system error.

Corruption

An on-disk sorted run (SSTable) is not intact.

Either a length prefix is implausibly large, or the file ends in the middle of a record. A damaged run cannot be trusted, so the read that touched it fails rather than returning partial or fabricated data. reason is a short, human-readable description of the inconsistency.

Fields

reason: &'static str

A short, human-readable reason the run was rejected.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 ForgeError for Error

fn is_fatal(&self) -> bool

Corruption is unrecoverable by retry: the bytes on disk are already damaged. I/O errors are left non-fatal for the caller to judge — a transient Interrupted or a recoverable WouldBlock may be retried.

fn kind(&self) -> &'static str

Returns the kind of error, typically matching the enum variant

fn caption(&self) -> &'static str

Returns a human-readable caption for the error

fn is_retryable(&self) -> bool

Returns true if the operation can be retried

fn status_code(&self) -> u16

Returns an appropriate HTTP status code for the error

fn exit_code(&self) -> i32

Returns an appropriate process exit code for the error

fn user_message(&self) -> String

Returns a user-facing message that can be shown to end users

fn dev_message(&self) -> String

Returns a detailed technical message for developers/logs

fn backtrace(&self) -> Option<&Backtrace>

Returns a backtrace if available

fn register(&self)

Registers the error with the central error registry

impl From<Error> for Error

A bare io::Error converts into Error::Io with a generic context.

Call sites that know what they were doing attach a specific context instead; this exists for the ? ergonomics of code — including doctests and examples — that does not.

fn from(source: Error) -> Self

Converts to this type from the input type.