Enum EvalError 

#[non_exhaustive]
pub enum EvalError {
    Io {
        path: PathBuf,
        source: Error,
    },
    Parse {
        path: PathBuf,
        reason: &'static str,
    },
    DimensionMismatch {
        expected: usize,
        found: usize,
    },
    LengthMismatch {
        kind: &'static str,
        expected: usize,
        found: usize,
    },
    KExceedsCorpus {
        k: usize,
        corpus_size: usize,
    },
    EmptyInput {
        kind: &'static str,
    },
    Search(IqdbError),
    UnsupportedVectorId {
        found: &'static str,
    },
}

An error from an iqdb-eval measurement or dataset-loading operation.

Each variant identifies one specific failure. The enum is #[non_exhaustive]: future releases may add variants without it being a breaking change, so a match on it must include a wildcard arm.

Examples

use iqdb_eval::EvalError;

let err = EvalError::DimensionMismatch { expected: 128, found: 64 };
assert_eq!(
    err.to_string(),
    "vector dimension mismatch: expected 128, found 64",
);

let err = EvalError::KExceedsCorpus { k: 100, corpus_size: 10 };
assert_eq!(
    err.to_string(),
    "k exceeds corpus size: k=100, corpus_size=10",
);

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.

Io

An OS-level I/O failure occurred while reading a dataset file. path is the file whose read failed; source is the underlying std::io::Error and is reachable via std::error::Error::source.

Fields

path: PathBuf

The path whose read or open call failed.

source: Error

The underlying I/O error.

Parse

A dataset file was opened successfully but its contents could not be parsed (truncated record, invalid header, etc.). reason is a short static description of the parser check that failed.

Fields

path: PathBuf

The path of the file whose contents could not be parsed.

reason: &'static str

Short static description of which parser check failed.

DimensionMismatch

A vector did not have the dimensionality the operation required. expected is what was required; found is what was supplied.

Fields

expected: usize

The dimensionality the operation required.

found: usize

The dimensionality that was actually supplied.

LengthMismatch

Two collections that had to share a length did not. kind names the pair (e.g. "queries vs ground_truth"); expected is the first collection’s length; found is the second’s.

Fields

kind: &'static str

Short, stable identifier for the collection pair.

expected: usize

The expected length (typically the first collection’s len()).

found: usize

The actual length (typically the second collection’s len()).

KExceedsCorpus

The requested k exceeds the corpus size, so a k-nearest result cannot be returned.

Fields

k: usize

The requested top-k count.

corpus_size: usize

The number of vectors searchable in the index.

EmptyInput

A required input collection was empty. kind names the collection (e.g. "queries", "base", "ground_truth").

Fields

kind: &'static str

Short, stable identifier for the empty input.

Search(IqdbError)

A nested IqdbError surfaced from a downstream IndexCore operation (typically iqdb_index::IndexCore::insert or iqdb_index::IndexCore::search).

UnsupportedVectorId

A VectorId shape that the harness cannot project to a u32 row-index was encountered while computing ground truth. The convention is documented on crate::build_index_from_base: callers must insert each base row at VectorId::U64(row_index). found is a short static identifier for the variant that was actually returned (for example, "VectorId::Bytes").

Fields

found: &'static str

Short identifier for the VectorId variant that was returned.

Trait Implementations

impl Debug for EvalError

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

Formats the value using the given formatter.

impl Display for EvalError

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

Formats the value using the given formatter.

impl Error for EvalError

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 ForgeError for EvalError

fn kind(&self) -> &'static str

Returns the kind of error, typically matching the enum variant

fn caption(&self) -> &'static str

Returns a human-readable caption for the error

fn is_retryable(&self) -> bool

Returns true if the operation can be retried

fn is_fatal(&self) -> bool

Returns true if the error is fatal and should terminate the program

fn status_code(&self) -> u16

Returns an appropriate HTTP status code for the error

fn exit_code(&self) -> i32

Returns an appropriate process exit code for the error

fn user_message(&self) -> String

Returns a user-facing message that can be shown to end users

fn dev_message(&self) -> String

Returns a detailed technical message for developers/logs

fn backtrace(&self) -> Option<&Backtrace>

Returns a backtrace if available

fn register(&self)

Registers the error with the central error registry

impl From<IqdbError> for EvalError

fn from(value: IqdbError) -> Self

Converts to this type from the input type.