Enum SegmentError 

pub enum SegmentError {
    CorruptFile {
        detail: String,
    },
    InvalidMagic,
    ChecksumMismatch {
        expected: u32,
        actual: u32,
    },
    UnsupportedVersion {
        version: u16,
        detail: String,
    },
    Io(Error),
    Encoding(EncodingError),
    AlreadyFinalized,
    EmptySegment,
    RowGroupOutOfRange {
        index: usize,
        max: usize,
    },
    MissingEncryptionKey {
        column: String,
        key_id: String,
    },
    InvalidConfiguration {
        detail: String,
    },
    ColumnNotFound {
        name: String,
    },
}

Errors that can occur during segment operations.

Variants

CorruptFile

The segment file is corrupt or has an invalid format.

Fields

detail: String

Human-readable description of the corruption.

InvalidMagic

Invalid magic bytes in header or footer.

ChecksumMismatch

CRC32c checksum mismatch.

Fields

expected: u32

Expected checksum value.

actual: u32

Actual computed checksum.

UnsupportedVersion

The segment belongs to a different format generation.

The message is built by crate::format::version_mismatch, so every durable format says the same thing in the same words — and names the remedy rather than printing a bare number, which is what this used to do.

Fields

version: u16

The version number found in the file.

detail: String

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

Io(Error)

An I/O error occurred.

Encoding(EncodingError)

An encoding error occurred.

AlreadyFinalized

The segment writer has already been finalized.

EmptySegment

No data has been written to the segment.

RowGroupOutOfRange

Row group index is out of range.

Fields

index: usize

Requested row group index.

max: usize

Maximum valid row group index.

MissingEncryptionKey

Column not found. An encrypted column cannot be read because its key is not available.

Not CorruptFile, which is what this used to be: nothing is wrong with the bytes. The deployment is missing a key, and the two have completely different next steps — one is “restore from a backup”, the other is “set the environment variable”. The commonest way to arrive here is restoring an encrypted backup onto a machine the key was never given to.

Fields

column: String

The column that cannot be read.

key_id: String

The key id its blocks were written under.

InvalidConfiguration

The writer was asked for something the format cannot honestly do.

Distinct from CorruptFile: nothing is wrong with the data, the configuration is wrong — declaring a tag column encrypted, for instance, which the format would accept and which would publish the value in the sidecar beside it.

Fields

detail: String

What was asked for, and why it cannot be done.

ColumnNotFound

A requested column is not in the segment.

Fields

name: String

The requested column name.

Trait Implementations

impl Debug for SegmentError

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

Formats the value using the given formatter.

impl Display for SegmentError

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

Formats the value using the given formatter.

impl Error for SegmentError

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<EncodingError> for SegmentError

fn from(source: EncodingError) -> Self

Converts to this type from the input type.

impl From<Error> for SegmentError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<SegmentError> for CacheError

fn from(source: SegmentError) -> Self

Converts to this type from the input type.

impl From<SegmentError> for CompactionError

fn from(source: SegmentError) -> Self

Converts to this type from the input type.

impl From<SegmentError> for MemtableError

fn from(source: SegmentError) -> Self

Converts to this type from the input type.