Enum VirtualClientsError 

pub enum VirtualClientsError {
    DerivationInfoMalformed,
    DerivationInfoDecryptionFailed,
    MissingOperationTree,
    MissingEmulationEpochState,
    StorageError,
    EncryptionKeyMismatch,
    CryptoError(CryptoError),
    HashOutputLengthMismatch {
        actual_length: usize,
        expected_length: usize,
    },
    Tls(Error),
    AppDataDictionaryNotSupported,
    VcComponentNotListed,
    IndexOutOfBounds,
    OperationGenerationConsumed,
    OperationGenerationTooDistant,
    OperationRatchetTooLong,
    LibraryError,
    DuplicateKeyPackageIndex(u32),
    DuplicateKeyPackageRef,
}

Available on crate feature extensions-draft and crate feature virtual-clients-draft and (32-bit or 64-bit) only.

Errors that can occur while processing virtual-clients derivation info.

Variants

DerivationInfoMalformed

The derivation-info bytes failed to deserialize.

DerivationInfoDecryptionFailed

AEAD decryption of the encrypted derivation info failed (wrong key, tampered ciphertext, or mismatched AAD).

MissingOperationTree

No virtual-clients operation secret tree was registered for this epoch.

MissingEmulationEpochState

No virtual-clients EmulationEpochState was registered for this epoch, or it has been deleted.

StorageError

Loading or storing virtual-clients state via the storage provider failed.

EncryptionKeyMismatch

The leaf encryption key in the path does not match the key derived from the path secret.

CryptoError(CryptoError)

A cryptographic operation failed during virtual-clients processing.

HashOutputLengthMismatch

Hash function produced output of unexpected length.

Fields

actual_length: usize

The number of bytes in the hash output.

expected_length: usize

The required number of bytes in the hash output.

Tls(Error)

TLS encoding/decoding of a virtual-clients structure failed. Covers both serialization on the sender side and deserialization of the decrypted DerivationInfoTbe on the receiver side.

AppDataDictionaryNotSupported

The leaf carrying (or about to carry) a VC derivation-info entry does not declare AppDataDictionary in its capabilities.

VcComponentNotListed

The leaf’s AppDataDictionary extension is missing the AppComponents entry, or that entry does not list VC_COMPONENT_ID.

IndexOutOfBounds

The requested leaf index lies outside the operation secret tree.

OperationGenerationConsumed

The operation secret for the requested generation was already derived and deleted for forward secrecy.

OperationGenerationTooDistant

The requested operation generation lies too far beyond the current ratchet head (see MAXIMUM_FORWARD_DISTANCE in the operation secret tree).

OperationRatchetTooLong

An operation ratchet has reached the maximum generation.

LibraryError

An unrecoverable error has occurred due to a bug in the implementation.

DuplicateKeyPackageIndex(u32)

The KeyPackageUpload lists the same key_package_index more than once. Each batch index must appear at most once.

DuplicateKeyPackageRef

The KeyPackageUpload lists the same KeyPackageRef more than once. Each KeyPackage reference must appear at most once.

Trait Implementations

impl Clone for VirtualClientsError

fn clone(&self) -> VirtualClientsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualClientsError

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

Formats the value using the given formatter.

impl Display for VirtualClientsError

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

Formats the value using the given formatter.

impl Error for VirtualClientsError

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<CryptoError> for VirtualClientsError

fn from(source: CryptoError) -> Self

Converts to this type from the input type.

impl From<Error> for VirtualClientsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<VirtualClientsError> for MessageDecryptionError

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for MessageEncryptionError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for WelcomeError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for VcExternalCommitJoinError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for VcGroupCreationJoinError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl From<VirtualClientsError> for StageCommitError

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl From<VirtualClientsError> for CreateCommitError

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for NewGroupError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for SelfUpdateError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<VirtualClientsError> for RegisterVcEmulationEpochError<StorageError>

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl From<VirtualClientsError> for KeyPackageNewError

fn from(source: VirtualClientsError) -> Self

Converts to this type from the input type.

impl PartialEq for VirtualClientsError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VirtualClientsError