Enum SegmentError 

#[non_exhaustive]
pub enum SegmentError {
    BadMagic,
    UnsupportedVersion {
        found: u16,
        expected: u16,
    },
    ChecksumMismatch {
        expected: u32,
        actual: u32,
    },
    Truncated,
    TermTooLong {
        term_len: usize,
        max: usize,
    },
}

All failure modes for reading or writing an FTS segment file.

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

Magic bytes at offset 0..4 do not match b"FTSS".

UnsupportedVersion

The segment was written by an incompatible format version.

Fields

found: u16

expected: u16

ChecksumMismatch

The footer CRC does not match the re-computed CRC of the preceding bytes.

Fields

expected: u32

actual: u32

Truncated

The file is shorter than the minimum valid segment size.

TermTooLong

A term exceeds the maximum encodable length (u16::MAX bytes).

Fields

term_len: usize

max: usize

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<E: Display> From<SegmentError> for FtsIndexError<E>

fn from(err: SegmentError) -> Self

Converts to this type from the input type.