Enum CleartextVectorDiscardingRetrievalError 

#[non_exhaustive]
pub enum CleartextVectorDiscardingRetrievalError<EngineError: Error> {
    CleartextCountMismatch,
    Engine(EngineError),
}

An error used with the CleartextVectorDiscardingRetrievalEngine trait.

This type provides a CleartextVectorDiscardingRetrievalError::perform_generic_checks function that does error checking for the general cases, returning an Ok(()) if the inputs are valid, meaning that engine implementors would then only need to check for their own specific errors. Otherwise an Err(..) with the proper error variant is returned.

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.

CleartextCountMismatch

Generic error: The input and output cleartext count must be the same.

Engine(EngineError)

Specific error to the implementing engine.

Implementations

impl<EngineError: Error> CleartextVectorDiscardingRetrievalError<EngineError>

pub fn perform_generic_checks<Value, CleartextVector>( output: &[Value], input: &CleartextVector, ) -> Result<(), Self>

where CleartextVector: CleartextVectorEntity,

Validates the inputs

Trait Implementations

impl<EngineError: Clone + Error> Clone for CleartextVectorDiscardingRetrievalError<EngineError>

fn clone(&self) -> CleartextVectorDiscardingRetrievalError<EngineError>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<EngineError: Debug + Error> Debug for CleartextVectorDiscardingRetrievalError<EngineError>

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

Formats the value using the given formatter.

impl<EngineError: Error> Display for CleartextVectorDiscardingRetrievalError<EngineError>

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

Formats the value using the given formatter.

impl<EngineError: Error> Error for CleartextVectorDiscardingRetrievalError<EngineError>

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<EngineError: PartialEq + Error> PartialEq for CleartextVectorDiscardingRetrievalError<EngineError>

fn eq( &self, other: &CleartextVectorDiscardingRetrievalError<EngineError>, ) -> 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<EngineError: Eq + Error> Eq for CleartextVectorDiscardingRetrievalError<EngineError>

impl<EngineError: Error> StructuralPartialEq for CleartextVectorDiscardingRetrievalError<EngineError>