Enum CodecError 

#[non_exhaustive]
pub enum CodecError {
    UnsupportedBitWidth {
        got: u8,
    },
    InvalidDimension {
        got: u32,
    },
    DimensionMismatch {
        expected: u32,
        got: u32,
    },
    CodebookIncompatible {
        expected: u8,
        got: u8,
    },
    ConfigMismatch {
        expected: Arc<str>,
        got: Arc<str>,
    },
    CodebookEntryCount {
        expected: u32,
        got: u32,
        bit_width: u8,
    },
    CodebookNotSorted,
    CodebookDuplicate {
        expected: u32,
        got: u32,
    },
    InsufficientTrainingData {
        expected: u32,
    },
    IndexOutOfRange {
        index: u8,
        bound: u32,
    },
    LengthMismatch {
        left: usize,
        right: usize,
    },
    InvalidResidualFlag {
        got: u8,
    },
}

Errors produced by the codec layer.

Maps 1:1 to tinyquant_cpu.codec._errors Python exceptions; see the mapping table in docs/design/rust/error-model.md.

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.

UnsupportedBitWidth

bit_width is outside the supported set {2, 4, 8}.

Fields

got: u8

The unsupported bit width value that was provided.

InvalidDimension

dimension is zero — every codec operation requires a non-zero dim.

Fields

got: u32

The invalid dimension value that was provided.

DimensionMismatch

Input vector length does not match the config’s declared dimension.

Fields

expected: u32

The dimension declared in the codec config.

got: u32

The actual length of the input vector.

CodebookIncompatible

Codebook was trained under a different bit_width than the config.

Fields

expected: u8

The bit width from the codec config.

got: u8

The bit width embedded in the codebook.

ConfigMismatch

A CompressedVector carries a config_hash that differs from the supplied CodecConfig.

Fields

expected: Arc<str>

Expected hash from the codec config.

got: Arc<str>

Actual hash found in the compressed vector.

CodebookEntryCount

Codebook entry count is inconsistent with bit_width.

Fields

expected: u32

Expected number of entries.

got: u32

Actual number of entries found.

bit_width: u8

The bit width that determines the expected count.

CodebookNotSorted

Codebook entries are not sorted in non-decreasing order.

CodebookDuplicate

Codebook contains non-unique entries (violates np.unique invariant).

Fields

expected: u32

Expected number of distinct values.

got: u32

Actual number of distinct values found.

InsufficientTrainingData

Training data contains fewer distinct values than needed to fill the codebook.

Fields

expected: u32

Minimum distinct entries required.

IndexOutOfRange

A codebook index exceeds the codebook’s valid range [0, 2^bit_width).

Fields

index: u8

The out-of-range index value.

bound: u32

The exclusive upper bound.

LengthMismatch

An internal length invariant was violated (caller or internal bug).

Fields

left: usize

Length of the left operand.

right: usize

Length of the right operand.

InvalidResidualFlag

The residual flag byte in a serialized payload was not 0x00 or 0x01.

Fields

got: u8

The invalid flag byte found.

Trait Implementations

impl Clone for CodecError

fn clone(&self) -> CodecError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecError

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

Formats the value using the given formatter.

impl Display for CodecError

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

Formats the value using the given formatter.

impl Error for CodecError

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<CodecError> for CorpusError

fn from(source: CodecError) -> Self

Converts to this type from the input type.

impl PartialEq for CodecError

fn eq(&self, other: &CodecError) -> 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 Eq for CodecError

impl StructuralPartialEq for CodecError