Enum SearchError 

pub enum SearchError {
    EmbedderUnavailable {
        model: String,
        reason: String,
    },
    EmbeddingFailed {
        model: String,
        source: Box<dyn Error + Send + Sync>,
    },
    ModelNotFound {
        name: String,
    },
    ModelLoadFailed {
        path: PathBuf,
        source: Box<dyn Error + Send + Sync>,
    },
    IndexCorrupted {
        path: PathBuf,
        detail: String,
    },
    IndexVersionMismatch {
        expected: u16,
        found: u16,
    },
    DimensionMismatch {
        expected: usize,
        found: usize,
    },
    IndexNotFound {
        path: PathBuf,
    },
    QueryParseError {
        query: String,
        detail: String,
    },
    SearchTimeout {
        elapsed_ms: u64,
        budget_ms: u64,
    },
    FederatedInsufficientResponses {
        required: usize,
        received: usize,
    },
    RerankerUnavailable {
        model: String,
    },
    RerankFailed {
        model: String,
        source: Box<dyn Error + Send + Sync>,
    },
    Io(Error),
    InvalidConfig {
        field: String,
        value: String,
        reason: String,
    },
    HashMismatch {
        path: PathBuf,
        expected: String,
        actual: String,
    },
    Cancelled {
        phase: String,
        reason: String,
    },
    QueueFull {
        pending: usize,
        capacity: usize,
    },
    SubsystemError {
        subsystem: &'static str,
        source: Box<dyn Error + Send + Sync>,
    },
    DurabilityDisabled,
}

Unified error type covering all failure modes across the frankensearch search pipeline.

Every variant includes an actionable error message guiding the consumer toward resolution. The TwoTierSearcher catches transient errors and degrades gracefully: fast embedding failures can still yield lexical-only initial results when lexical retrieval is available, RerankFailed skips reranking, and SearchTimeout yields initial results. Only IndexNotFound and InvalidConfig prevent search from starting.

Variants

EmbedderUnavailable

An embedding model is not available (not compiled in, or model files missing).

Fields

model: String

Identifier of the unavailable model.

reason: String

Why it is unavailable.

EmbeddingFailed

Embedding inference failed for a given model.

Fields

model: String

Which model failed.

source: Box<dyn Error + Send + Sync>

The underlying error.

ModelNotFound

Model files were not found at any searched path.

Fields

name: String

Model identifier.

ModelLoadFailed

Model files exist but failed to load (corrupted, incompatible version, etc.).

Fields

path: PathBuf

Path that was attempted.

source: Box<dyn Error + Send + Sync>

The underlying error.

IndexCorrupted

The vector index file is corrupted (bad magic, CRC mismatch, truncated).

Fields

path: PathBuf

Path to the corrupted file.

detail: String

Nature of the corruption.

IndexVersionMismatch

The FSVI file version does not match what this build expects.

Fields

expected: u16

The version this library expects.

found: u16

The version found in the file.

DimensionMismatch

Query vector dimension does not match the index dimension.

Fields

expected: usize

Dimension the index was built with.

found: usize

Dimension of the query vector.

IndexNotFound

No vector index file exists at the expected path.

Fields

path: PathBuf

Expected path.

QueryParseError

The query string could not be parsed.

Fields

query: String

The problematic query.

detail: String

What went wrong.

SearchTimeout

A search phase exceeded its time budget.

Fields

elapsed_ms: u64

How long the operation ran.

budget_ms: u64

The configured budget.

FederatedInsufficientResponses

Federated search did not receive enough successful shard responses.

Fields

required: usize

Minimum responses required by config.

received: usize

Number of successful shard responses observed.

RerankerUnavailable

The reranking model is not available.

Fields

model: String

Model identifier.

RerankFailed

Reranking inference failed.

Fields

model: String

Which reranker model failed.

source: Box<dyn Error + Send + Sync>

The underlying error.

Io(Error)

Wraps std::io::Error for file operations.

InvalidConfig

A configuration value is invalid.

Fields

field: String

Which config field.

value: String

The invalid value.

reason: String

Why it is invalid.

HashMismatch

Downloaded or loaded file does not match expected hash.

Fields

path: PathBuf

Path to the file.

expected: String

Expected hash (hex string).

actual: String

Actual computed hash.

Cancelled

Operation was cancelled via the asupersync structured concurrency protocol.

Fields

phase: String

Which phase was active when cancelled.

reason: String

Cancellation reason.

QueueFull

The embedding job queue is full.

Fields

pending: usize

Number of pending items.

capacity: usize

Queue capacity.

SubsystemError

Wraps errors from optional subsystems (storage, durability, FTS5, etc.).

Always present in the enum regardless of feature flags, avoiding match-arm breakage across feature combinations.

Fields

subsystem: &'static str

Which subsystem produced the error (e.g., “storage”, “durability”, “fts5”).

source: Box<dyn Error + Send + Sync>

The underlying error.

DurabilityDisabled

A durability/repair feature was requested but is not compiled in.

Trait Implementations

impl Debug for SearchError

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

Formats the value using the given formatter.

impl Display for SearchError

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

Formats the value using the given formatter.

impl Error for SearchError

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<Error> for SearchError

fn from(source: Error) -> Self

Converts to this type from the input type.