Enum FtsIndexError 

#[non_exhaustive]
pub enum FtsIndexError<E: Display> {
    SurrogateOutOfRange {
        surrogate: Surrogate,
    },
    TermTooLong {
        len: usize,
        max: usize,
    },
    InvalidQuery(InvalidQuery),
    Backend(E),
    Segment(SegmentError),
    BudgetExhausted(MemError),
}

Errors returned by FtsIndex write operations.

E is the backend error type (B::Error). Backend errors are wrapped in FtsIndexError::Backend so callers get a single error type.

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.

SurrogateOutOfRange

The supplied Surrogate is outside the indexable range 1..=MAX_INDEXABLE_SURROGATE.

Either the zero sentinel (Surrogate::ZERO, meaning “not yet assigned”) or a value at u32::MAX was passed to index_document. The Control Plane surrogate allocator must ensure surrogates are in range before dispatching indexing operations.

Fields

surrogate: Surrogate

TermTooLong

A term in the document exceeds the on-disk u16 length cap.

The FTS segment format encodes term lengths as u16 (see lsm/segment/format.rs::MAX_TERM_LEN). Terms longer than u16::MAX (65 535 bytes) cannot be persisted. After analysis, real-world terms are typically 2-20 bytes — exceeding this cap indicates a malformed analyzer or adversarial input.

Fields

len: usize

max: usize

InvalidQuery(InvalidQuery)

The FTS query string is invalid (e.g. NOT-only, unsupported parentheses).

Backend(E)

An underlying backend storage operation failed.

Segment(SegmentError)

A segment I/O or validation error not otherwise classified.

Read-side variants (BadMagic, UnsupportedVersion, ChecksumMismatch, Truncated) are not expected on the write/flush path but are propagated here rather than panicking, so corrupt-state surprises surface as typed errors at the public API boundary.

BudgetExhausted(MemError)

Memory budget exhausted for the FTS engine.

The operation requires more memory than the engine’s remaining budget allows. Callers should backpressure, spill, or reject the request.

Trait Implementations

impl<E: Debug + Display> Debug for FtsIndexError<E>

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

Formats the value using the given formatter.

impl<E> Display for FtsIndexError<E>

where E: Display + Display,

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

Formats the value using the given formatter.

impl<E: Display> Error for FtsIndexError<E>

where Self: Debug + Display,

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<InvalidQuery> for FtsIndexError<E>

fn from(source: InvalidQuery) -> Self

Converts to this type from the input type.

impl<E: Display> From<MemError> for FtsIndexError<E>

fn from(e: MemError) -> Self

Converts to this type from the input type.

impl<E: Display> From<SegmentError> for FtsIndexError<E>

fn from(err: SegmentError) -> Self

Converts to this type from the input type.