Enum PlaidError 

pub enum PlaidError {
    Tensor(Error),
    InvalidCodec(String),
    InvalidIndex(String),
    Io(Error),
}

Every failure the PLAID pipeline can surface.

Variants

Tensor(Error)

Underlying tensor operation failed (allocation, matmul, transpose, argmin, etc.). Wraps candle_core::Error so callers can downcast when they care about the specific cause but still propagate uniformly via ?.

InvalidCodec(String)

A ResidualCodec failed its shape/invariant checks. Raised from encode_vector, decode_vector, batch_encode_tokens, and build_index’s validate step. The wrapped String describes the specific constraint violated (dim == 0, nbits not in {1,2,4,8}, non-monotonic cutoffs, etc.).

InvalidIndex(String)

An on-disk index file was readable but its contents violated the expected format (wrong magic bytes, unknown format version, out-of-range header fields, or a centroid_id above the advertised k_centroids). Distinct from Io — the file was reached, it’s just malformed.

Io(Error)

Low-level I/O failure (open/read/write/flush). Wraps std::io::Error verbatim so callers retain the original error kind when they need it.

Trait Implementations

impl Debug for PlaidError

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

Formats the value using the given formatter.

impl Display for PlaidError

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

Formats the value using the given formatter.

impl Error for PlaidError

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 PlaidError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for PlaidError

fn from(source: Error) -> Self

Converts to this type from the input type.