Enum IndexError 

#[non_exhaustive]
pub enum IndexError {
    BadMagic {
        found: Vec<u8>,
    },
    UnsupportedVersion(u64),
    InvalidWindowSize(u64),
    ExcessiveLength {
        what: &'static str,
        value: u64,
    },
    InvalidCheckpoint(&'static str),
    ArchiveSizeMismatch {
        index_size: u64,
        archive_size: u64,
    },
    Truncated,
    WindowCodec(&'static str),
    AllocationFailed {
        what: &'static str,
    },
    UnsupportedFlags {
        flags: u64,
    },
    MissingMetadata(&'static str),
    IncompatibleFormat {
        operation: &'static str,
        kind: IndexKind,
    },
    Io {
        source: Arc<Error>,
    },
}

Errors produced while parsing, validating, or writing an index.

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.

BadMagic

The file did not begin with the expected magic bytes.

Fields

found: Vec<u8>

The bytes actually observed.

UnsupportedVersion(u64)

The format version is newer than this crate supports.

InvalidWindowSize(u64)

The index declared a window size other than WINDOW_SIZE.

ExcessiveLength

A declared count or length exceeded the accepted maximum.

Fields

what: &'static str

What the value described.

value: u64

The value read from the file.

InvalidCheckpoint(&'static str)

A checkpoint field was denormal or inconsistent.

ArchiveSizeMismatch

A caller-supplied archive size disagreed with the index.

Fields

index_size: u64

Size recorded in the index.

archive_size: u64

Size supplied by the caller.

Truncated

The index ended before a complete value could be read.

WindowCodec(&'static str)

A window payload could not be compressed or decompressed.

AllocationFailed

The process could not reserve memory within the configured limit.

Fields

what: &'static str

What allocation was attempted.

UnsupportedFlags

A format contained flags this crate does not understand.

Fields

flags: u64

Flags observed in the input.

MissingMetadata(&'static str)

An operation requires metadata not present in this index.

IncompatibleFormat

The selected on-disk representation cannot encode this source format.

Fields

operation: &'static str

Operation or on-disk representation that was requested.

kind: IndexKind

Provenance recorded by the index.

Io

An I/O failure occurred.

Fields

source: Arc<Error>

The original error.

Trait Implementations

impl Clone for IndexError

fn clone(&self) -> IndexError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexError

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

Formats the value using the given formatter.

impl Display for IndexError

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

Formats the value using the given formatter.

impl Eq for IndexError

impl Error for IndexError

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<IndexError> for IndexDecodeError

fn from(error: IndexError) -> Self

Converts to this type from the input type.

impl From<IndexError> for IndexingError

fn from(error: IndexError) -> Self

Converts to this type from the input type.

impl From<IndexError> for IndexedReaderError

fn from(error: IndexError) -> Self

Converts to this type from the input type.

impl PartialEq for IndexError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.