Enum WelcomeError 

pub enum WelcomeError<StorageError> {
    GroupSecrets(GroupSecretsError),
    PrivateInitKeyNotFound,
    LibraryError(LibraryError),
    CiphersuiteMismatch,
    GroupInfo(GroupInfoError),
    JoinerSecretNotFound,
    MissingRatchetTree,
    ConfirmationTagMismatch,
    InvalidGroupInfoSignature,
    UnsupportedMlsVersion,
    UnsupportedCapability,
    UnsupportedCiphersuite(Ciphersuite),
    UnknownSender,
    NotAWelcomeMessage,
    MalformedWelcomeMessage,
    UnableToDecrypt,
    UnsupportedExtensions,
    Psk(PskError),
    NoMatchingEncryptionKey,
    NoMatchingKeyPackage,
    PublicTreeError(PublicTreeError),
    PublicGroupError(CreationFromExternalError<StorageError>),
    LeafNodeValidation(LeafNodeValidationError),
    StorageError(StorageError),
    GroupAlreadyExists,
    VirtualClientsError(VirtualClientsError),
    RegisterVcDerivationEpoch(RegisterVcDerivationEpochError<StorageError>),
    KeySchedule(KeyScheduleError),
    SubgroupParameterMismatch,
    SubgroupEpochInvalid,
    SubgroupLeafMismatch,
    SubgroupParentMismatch,
}

Available on 32-bit or 64-bit only.

Welcome error

Variants

GroupSecrets(GroupSecretsError)

See GroupSecretsError for more details.

PrivateInitKeyNotFound

Private part of init_key not found in key store.

LibraryError(LibraryError)

See LibraryError for more details.

CiphersuiteMismatch

Ciphersuites in Welcome and key package bundle don’t match.

GroupInfo(GroupInfoError)

See GroupInfoError for more details.

JoinerSecretNotFound

No joiner secret found in the Welcome message.

MissingRatchetTree

No ratchet tree available to build initial tree after receiving a Welcome message.

ConfirmationTagMismatch

The computed confirmation tag does not match the expected one.

InvalidGroupInfoSignature

The signature on the GroupInfo is not valid.

UnsupportedMlsVersion

We don’t support the version of the group we are trying to join.

UnsupportedCapability

We don’t support all capabilities of the group.

UnsupportedCiphersuite(Ciphersuite)

The crypto provider doesn’t support the ciphersuite of the group we are trying to join.

UnknownSender

Sender not found in tree.

NotAWelcomeMessage

The provided message is not a Welcome message.

MalformedWelcomeMessage

Malformed Welcome message.

UnableToDecrypt

Could not decrypt the Welcome message.

UnsupportedExtensions

Unsupported extensions found in the GroupContext or KeyPackage of another member.

Psk(PskError)

See PskError for more details.

NoMatchingEncryptionKey

No matching encryption key was found in the key store.

NoMatchingKeyPackage

No matching key package was found in the key store.

PublicTreeError(PublicTreeError)

This error indicates the public tree is invalid. See PublicTreeError for more details.

PublicGroupError(CreationFromExternalError<StorageError>)

This error indicates the public tree is invalid. See CreationFromExternalError for more details.

LeafNodeValidation(LeafNodeValidationError)

This error indicates the leaf node is invalid. See LeafNodeValidationError for more details.

StorageError(StorageError)

This error indicates that an error occurred while reading or writing from/to storage.

GroupAlreadyExists

A group with this GroupId already exists.

VirtualClientsError(VirtualClientsError)

Available on crate feature virtual-clients-draft only.

A virtual-clients error occurred while deriving or validating the virtual client’s join material.

RegisterVcDerivationEpoch(RegisterVcDerivationEpochError<StorageError>)

Available on crate feature virtual-clients-draft only.

The joined group is an emulation group, and registering the derivation epoch of the Welcome’s output epoch failed.

KeySchedule(KeyScheduleError)

This error indicates that computing the key schedule failed

SubgroupParameterMismatch

The subgroup’s protocol version or ciphersuite does not match the parent group (RFC 9420 §11.3).

SubgroupEpochInvalid

The subgroup is not at epoch 1, as required for a branched subgroup (RFC 9420 §11.3).

SubgroupLeafMismatch

A member of the subgroup does not match any member of the parent group (RFC 9420 §11.3).

SubgroupParentMismatch

The parent group or epoch referenced by the subgroup’s branch PSK does not match the provided parent group information (RFC 9420 §11.3).

Trait Implementations

impl<StorageError: Clone> Clone for WelcomeError<StorageError>

fn clone(&self) -> WelcomeError<StorageError>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<StorageError: Debug> Debug for WelcomeError<StorageError>

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

Formats the value using the given formatter.

impl<StorageError> Display for WelcomeError<StorageError>

where CreationFromExternalError<StorageError>: Display, RegisterVcDerivationEpochError<StorageError>: Display,

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

Formats the value using the given formatter.

impl<StorageError> Error for WelcomeError<StorageError>

where CreationFromExternalError<StorageError>: Error, RegisterVcDerivationEpochError<StorageError>: Error, Self: Debug + Display,

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<StorageError> From<CreationFromExternalError<StorageError>> for WelcomeError<StorageError>

fn from(source: CreationFromExternalError<StorageError>) -> Self

Converts to this type from the input type.

impl<StorageError> From<GroupInfoError> for WelcomeError<StorageError>

fn from(source: GroupInfoError) -> Self

Converts to this type from the input type.

impl<StorageError> From<GroupSecretsError> for WelcomeError<StorageError>

fn from(source: GroupSecretsError) -> Self

Converts to this type from the input type.

impl<StorageError> From<KeyScheduleError> for WelcomeError<StorageError>

fn from(source: KeyScheduleError) -> Self

Converts to this type from the input type.

impl<StorageError> From<LeafNodeValidationError> for WelcomeError<StorageError>

fn from(source: LeafNodeValidationError) -> Self

Converts to this type from the input type.

impl<StorageError> From<LibraryError> for WelcomeError<StorageError>

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl<StorageError> From<PskError> for WelcomeError<StorageError>

fn from(source: PskError) -> Self

Converts to this type from the input type.

impl<StorageError> From<PublicTreeError> for WelcomeError<StorageError>

fn from(source: PublicTreeError) -> Self

Converts to this type from the input type.

impl<StorageError> From<RegisterVcDerivationEpochError<StorageError>> for WelcomeError<StorageError>

fn from(source: RegisterVcDerivationEpochError<StorageError>) -> 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<WelcomeError<StorageError>> for ClientError<StorageError>

Available on crate features test-utils only.

fn from(source: WelcomeError<StorageError>) -> Self

Converts to this type from the input type.

impl<StorageError: PartialEq> PartialEq for WelcomeError<StorageError>

fn eq(&self, other: &WelcomeError<StorageError>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<StorageError: PartialEq> StructuralPartialEq for WelcomeError<StorageError>