Enum SimilarCodeError 

#[non_exhaustive]
pub enum SimilarCodeError {
    ZeroDimensions,
    InvalidThreshold,
    ExtractionVersion {
        location: FunctionLocation,
        expected: u32,
        actual: u32,
    },
    DimensionMismatch {
        location: FunctionLocation,
        expected: usize,
        actual: usize,
    },
    NonFiniteVector {
        location: FunctionLocation,
    },
    ZeroMagnitudeVector {
        location: FunctionLocation,
    },
    DuplicateFunctionIdentity {
        location: FunctionLocation,
    },
    SelectionLengthMismatch {
        expected: usize,
        actual: usize,
    },
    SelectionLimitExceeded {
        reason: SimilarCodeSkipReason,
        observed: usize,
        limit: usize,
    },
}

Invalid input rejected before candidate output is produced.

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.

ZeroDimensions

The configured vector width was zero.

InvalidThreshold

The similarity threshold was non-finite or outside -1 through 1.

ExtractionVersion

A vector used an unexpected extraction version.

Fields

location: FunctionLocation

Source location of the invalid vector.

expected: u32

Expected extraction version.

actual: u32

Actual extraction version.

DimensionMismatch

A vector width differed from the configured width.

Fields

location: FunctionLocation

Source location of the invalid vector.

expected: usize

Expected vector width.

actual: usize

Actual vector width.

NonFiniteVector

A vector contained NaN or infinity.

Fields

location: FunctionLocation

Source location of the invalid vector.

ZeroMagnitudeVector

A vector had zero magnitude and cannot be compared by cosine similarity.

Fields

location: FunctionLocation

Source location of the invalid vector.

DuplicateFunctionIdentity

More than one vector claimed the same stable function identity.

Fields

location: FunctionLocation

Source location shared by the duplicate inputs.

SelectionLengthMismatch

Preselected vector or scope count did not match the source selection contract.

Fields

expected: usize

Number of aligned entries expected from selected source indices.

actual: usize

Number of aligned entries supplied.

SelectionLimitExceeded

A caller-supplied preselection exceeded one current hard limit.

Fields

reason: SimilarCodeSkipReason

Limit that the preselection exceeded.

observed: usize

Observed functions, bytes, or comparisons.

limit: usize

Maximum admitted functions, bytes, or comparisons.

Trait Implementations

impl Clone for SimilarCodeError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimilarCodeError

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

Formats the value using the given formatter.

impl Display for SimilarCodeError

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

Formats the value using the given formatter.

impl Eq for SimilarCodeError

impl Error for SimilarCodeError

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SimilarCodeError