Enum IqdbError 

#[non_exhaustive]
pub enum IqdbError {
    DimensionMismatch {
        expected: usize,
        found: usize,
    },
    InvalidVector,
    InvalidConfig {
        reason: &'static str,
    },
    NotFound,
    Duplicate,
    InvalidMetric,
    InvalidFilter,
    ResourceLimitExceeded {
        kind: &'static str,
        max: usize,
        found: usize,
    },
}

An error from an iqdb vector-database 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_types::IqdbError;

let err = IqdbError::DimensionMismatch { expected: 3, found: 2 };
assert_eq!(
    err.to_string(),
    "vector dimension mismatch: expected 3, found 2",
);

let cfg = IqdbError::InvalidConfig { reason: "dim must be greater than zero" };
assert_eq!(
    cfg.to_string(),
    "invalid configuration: dim must be greater than zero",
);

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.

DimensionMismatch

A vector did not have the dimensionality the operation required — expected is the index’s dimension, found is what was supplied.

Fields

expected: usize

The dimensionality the operation required.

found: usize

The dimensionality that was actually supplied.

InvalidVector

A vector was not valid for the operation (for example, empty when a non-empty vector was required).

InvalidConfig

A configuration value could not describe a working index or query. reason is a short static description of which configuration check failed, suitable for inclusion in operator-facing logs.

Fields

reason: &'static str

Short static description of which configuration check failed.

NotFound

The requested id or record does not exist.

Duplicate

An insert collided with an id that is already present.

InvalidMetric

The distance metric was not valid for the operation or the vectors.

InvalidFilter

A filter expression was malformed or could not be evaluated.

ResourceLimitExceeded

An incoming write exceeded a configured resource limit. kind names which cap was hit (one of "id_bytes", "metadata_keys", "metadata_key_bytes", "metadata_value_string_bytes", "total_vectors"); max is the cap; found is what the caller supplied. Surfaces from the Database write boundary; the type-level constructors in this crate never produce it.

Fields

kind: &'static str

Short, stable identifier for the cap that was exceeded.

max: usize

The configured maximum the cap allowed.

found: usize

The value the caller actually supplied.

Trait Implementations

impl Clone for IqdbError

fn clone(&self) -> IqdbError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for IqdbError

impl Debug for IqdbError

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

Formats the value using the given formatter.

impl Display for IqdbError

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

Formats the value using the given formatter.

impl Eq for IqdbError

impl Error for IqdbError

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 IqdbError

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 PartialEq for IqdbError

fn eq(&self, other: &IqdbError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for IqdbError