Enum fst::raw::Error

pub enum Error {
    Version {
        expected: u64,
        got: u64,
    },
    Format,
    DuplicateKey {
        got: Vec<u8>,
    },
    OutOfOrder {
        previous: Vec<u8>,
        got: Vec<u8>,
    },
    WrongType {
        expected: FstType,
        got: FstType,
    },
    FromUtf8(FromUtf8Error),
}

An error that occurred while using a finite state transducer.

Variants

Version

Fields

expected: u64

The expected version, which is hard-coded into the current version of this crate.

got: u64

The version read from the finite state transducer.

A version mismatch occurred while reading a finite state transducer.

This occurs when the API version (of the crate) does not match the version encoded in the finite state transducer.

When this error is encountered, there are only two ways to fix it:

1. Change the version of the library to one that is compatible with the given finite state transducer.
2. Rebuild the finite state transducer.

Format

An unexpected error occurred while reading a finite state transducer. Usually this occurs because the data is corrupted or is not actually a finite state transducer serialized by this library.

DuplicateKey

Fields

got: Vec<u8>

The duplicate key.

A duplicate key was inserted into a finite state transducer, which is not allowed.

OutOfOrder

Fields

previous: Vec<u8>

The last key successfully inserted.

got: Vec<u8>

The key that caused this error to occur.

A key was inserted out of order into a finite state transducer.

Keys must always be inserted in lexicographic order.

WrongType

Fields

expected: FstType

The expected finite state transducer type.

got: FstType

The type read from a finite state transducer.

A finite state transducer with an unexpected type was found.

This is not currently used in this crate, but callers may wish to employ its use for alternative data structures implemented on top of finite state transducers.

FromUtf8(FromUtf8Error)

An error that occurred when trying to decode a UTF-8 byte key.

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 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 source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn provide<'a>(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl From<Error> for Error

fn from(err: Error) -> Error

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(err: FromUtf8Error) -> Self

Converts to this type from the input type.