Enum SessionRecipientCollectionError

pub enum SessionRecipientCollectionError {
    VerifiedUserHasUnsignedDevice(BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>),
    VerifiedUserChangedIdentity(Vec<OwnedUserId>),
    CrossSigningNotSetup,
    SendingFromUnverifiedDevice,
}

Error representing a problem when collecting the recipient devices for the room key, during an encryption operation.

Variants

VerifiedUserHasUnsignedDevice(BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>)

One or more verified users has one or more unsigned devices.

Happens only with CollectStrategy::DeviceBasedStrategy when error_on_verified_user_problem is true.

In order to resolve this, the caller can set the trust level of the affected devices to LocalTrust::Ignored or LocalTrust::BlackListed (see Device::set_local_trust), and then retry the encryption operation.

VerifiedUserChangedIdentity(Vec<OwnedUserId>)

One or more users was previously verified, but they have changed their identity.

Happens only with CollectStrategy::DeviceBasedStrategy when error_on_verified_user_problem is true, or with CollectStrategy::IdentityBasedStrategy.

In order to resolve this, the user can:

• re-verify the problematic recipients, or

• withdraw verification of the problematic recipients with OtherUserIdentity::withdraw_verification, or

• set the trust level of all of the devices belonging to the problematic recipients to LocalTrust::Ignored or LocalTrust::BlackListed (see Device::set_local_trust).

The caller can then retry the encryption operation.

CrossSigningNotSetup

Cross-signing has not been configured on our own identity.

Happens only with CollectStrategy::IdentityBasedStrategy. (Cross-signing is required for encryption when using IdentityBasedStrategy.) Apps should detect this condition and prevent sending in the UI rather than waiting for this error to be returned when encrypting.

SendingFromUnverifiedDevice

The current device has not been cross-signed by our own identity.

Happens only with CollectStrategy::IdentityBasedStrategy. (Cross-signing is required for encryption when using IdentityBasedStrategy.) Apps should detect this condition and prevent sending in the UI rather than waiting for this error to be returned when encrypting.

Trait Implementations

impl Debug for SessionRecipientCollectionError

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

Formats the value using the given formatter.

impl Display for SessionRecipientCollectionError

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

Formats the value using the given formatter.

impl Error for SessionRecipientCollectionError

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.