Enum CollectStrategy

pub enum CollectStrategy {
    DeviceBasedStrategy {
        only_allow_trusted_devices: bool,
        error_on_verified_user_problem: bool,
    },
    IdentityBasedStrategy,
}

Strategy to collect the devices that should receive room keys for the current discussion.

Variants

DeviceBasedStrategy

Device based sharing strategy.

Fields

only_allow_trusted_devices: bool

If true, devices that are not trusted will be excluded from the conversation. A device is trusted if any of the following is true: - It was manually marked as trusted. - It was marked as verified via interactive verification. - It is signed by its owner identity, and this identity has been trusted via interactive verification. - It is the current own device of the user.

error_on_verified_user_problem: bool

If true, and a verified user has an unsigned device, key sharing will fail with a SessionRecipientCollectionError::VerifiedUserHasUnsignedDevice.

If true, and a verified user has replaced their identity, key sharing will fail with a SessionRecipientCollectionError::VerifiedUserChangedIdentity.

Otherwise, keys are shared with unsigned devices as normal.

Once the problematic devices are blacklisted or whitelisted the caller can retry to share a second time.

IdentityBasedStrategy

Share based on identity. Only distribute to devices signed by their owner. If a user has no published identity he will not receive any room keys.

Implementations

impl CollectStrategy

pub const fn new_identity_based() -> Self

Creates an identity based strategy

Trait Implementations

impl Clone for CollectStrategy

fn clone(&self) -> CollectStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectStrategy

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

Formats the value using the given formatter.

impl Default for CollectStrategy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CollectStrategy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CollectStrategy

fn eq(&self, other: &CollectStrategy) -> 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 Serialize for CollectStrategy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CollectStrategy