Enum StorageError 

#[non_exhaustive]
pub enum StorageError {
    Corrupted(String),
    Internal(String),
    ValueTooLarge(usize),
    BlobNotFound(u64),
    BlobChecksumMismatch {
        sequence: u64,
        expected: u128,
        actual: u128,
    },
    BlobWriterActive,
    BlobWriterFinished,
    BlobRangeOutOfBounds {
        blob_length: u64,
        requested_offset: u64,
        requested_length: u64,
    },
    MemoryBudgetExceeded {
        budget: usize,
        used: usize,
    },
    HistorySnapshotNotFound(u64),
    InvalidPageType {
        page_region: u32,
        page_index: u32,
        page_order: u8,
        found: u8,
    },
    InvalidChildRef {
        page_region: u32,
        page_index: u32,
        page_order: u8,
        child_index: usize,
        is_checksum: bool,
    },
    InvalidEntryIndex {
        page_region: u32,
        page_index: u32,
        page_order: u8,
        entry_index: usize,
    },
    PageCorrupted {
        page_region: u32,
        page_index: u32,
        page_order: u8,
        detail: &'static str,
    },
    CdcCursorBehindRetention {
        cursor_txn_id: u64,
        oldest_retained_txn_id: u64,
    },
    InvalidConfiguration {
        message: String,
    },
    IndexNotTrained {
        index_name: String,
    },
    DimensionMismatch {
        index_name: String,
        expected: usize,
        actual: usize,
    },
    InvalidIndexConfig {
        detail: String,
    },
    FormatError {
        detail: String,
    },
    RecoveryRequired,
    OutOfSpace,
    LockTimeout(String),
    Io(BackendError),
    PreviousIo,
    DatabaseClosed,
    LockPoisoned(&'static Location<'static>),
}

General errors directly from the storage layer

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.

Corrupted(String)

The Database is corrupted

Internal(String)

An internal invariant was violated, indicating a bug in the database engine. This is NOT caused by on-disk corruption – it means the code has a logic error. If you encounter this error, please file a bug report.

ValueTooLarge(usize)

The value being inserted exceeds the maximum of 3GiB

BlobNotFound(u64)

A blob with the given sequence ID was not found in the blob store

BlobChecksumMismatch

Blob data checksum does not match the stored checksum

Fields

sequence: u64

Blob sequence number

expected: u128

Checksum stored in metadata

actual: u128

Checksum computed from the blob data

BlobWriterActive

A streaming blob writer is already active on this transaction

BlobWriterFinished

The streaming blob writer has already been finished

BlobRangeOutOfBounds

The requested byte range exceeds the blob’s length

Fields

blob_length: u64

Total blob length in bytes

requested_offset: u64

Requested range start offset

requested_length: u64

Requested range length

MemoryBudgetExceeded

The configured memory budget has been exceeded and the operation cannot proceed

Fields

budget: usize

The configured memory budget in bytes

used: usize

Current memory usage in bytes

HistorySnapshotNotFound(u64)

The requested history snapshot was not found for the given transaction ID

InvalidPageType

A B-tree page has an unexpected type byte

Fields

page_region: u32

Page region

page_index: u32

Page index within region

page_order: u8

Page order

found: u8

The invalid type byte found

InvalidChildRef

A child pointer or checksum on a B-tree branch page is invalid

Fields

page_region: u32

Page region

page_index: u32

Page index within region

page_order: u8

Page order

child_index: usize

Child index within the branch node

is_checksum: bool

Whether this is a checksum error (true) or a pointer error (false)

InvalidEntryIndex

An entry index on a B-tree page is invalid or out of range

Fields

page_region: u32

Page region

page_index: u32

Page index within region

page_order: u8

Page order

entry_index: usize

The invalid entry index

PageCorrupted

A B-tree page has structural corruption

Fields

page_region: u32

Page region

page_index: u32

Page index within region

page_order: u8

Page order

detail: &'static str

Static description of the corruption

CdcCursorBehindRetention

A CDC cursor position falls behind the retention window, meaning entries have been pruned and the consumer may have missed changes.

Fields

cursor_txn_id: u64

The cursor position (transaction ID the consumer last processed)

oldest_retained_txn_id: u64

The oldest transaction ID still in the CDC log

InvalidConfiguration

A configuration parameter is invalid (e.g. page size, region size).

Fields

message: String

Description of the invalid configuration

IndexNotTrained

The IVF-PQ index has not been trained yet

Fields

index_name: String

Name of the untrained index

DimensionMismatch

Vector dimensionality does not match the index configuration

Fields

index_name: String

Name of the index

expected: usize

Dimension the index was configured with

actual: usize

Dimension of the provided vector

InvalidIndexConfig

IVF-PQ index configuration is invalid

Fields

detail: String

Description of the invalid configuration

FormatError

On-disk format validation failed (magic number, version, layout, record structure)

Fields

detail: String

Description of the format violation

RecoveryRequired

Database requires recovery before this operation can proceed

OutOfSpace

Storage space exhausted; the allocator cannot grow further

LockTimeout(String)

Timed out waiting for a write transaction lock (no_std spin-lock). This is transient contention, not corruption.

Io(BackendError)

PreviousIo

DatabaseClosed

LockPoisoned(&'static Location<'static>)

Trait Implementations

impl Debug for StorageError

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

Formats the value using the given formatter.

impl Display for StorageError

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

Formats the value using the given formatter.

impl Error for StorageError

Available on crate feature std only.

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<BackendError> for StorageError

fn from(err: BackendError) -> StorageError

Converts to this type from the input type.

impl From<Error> for StorageError

Available on crate feature std only.

fn from(err: Error) -> StorageError

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for StorageError

Available on crate feature std only.

fn from(_: PoisonError<T>) -> StorageError

Converts to this type from the input type.

impl From<StorageError> for CommitError

fn from(err: StorageError) -> CommitError

Converts to this type from the input type.

impl From<StorageError> for CompactionError

fn from(err: StorageError) -> CompactionError

Converts to this type from the input type.

impl From<StorageError> for DatabaseError

fn from(err: StorageError) -> DatabaseError

Converts to this type from the input type.

impl From<StorageError> for Error

fn from(err: StorageError) -> Error

Converts to this type from the input type.

impl From<StorageError> for SavepointError

fn from(err: StorageError) -> SavepointError

Converts to this type from the input type.

impl From<StorageError> for TableError

fn from(err: StorageError) -> TableError

Converts to this type from the input type.

impl From<StorageError> for TransactionError

fn from(err: StorageError) -> TransactionError

Converts to this type from the input type.