Enum matrix_sdk_crypto::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<UT> ConvertError<UT> for CollectStrategy

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

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<UT> FfiConverter<UT> for CollectStrategy

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a MetadataBuffer.

impl<UT> Lift<UT> for CollectStrategy

type FfiType = <CollectStrategy as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for CollectStrategy

type LiftType = CollectStrategy

impl<UT> LiftReturn<UT> for CollectStrategy

type ReturnType = <CollectStrategy as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for CollectStrategy

type FfiType = <CollectStrategy as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for CollectStrategy

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CollectStrategy

type ReturnType = <CollectStrategy as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustBuffer>

Lower this value for scaffolding function return

fn handle_failed_lift(arg_name: &str, e: Error) -> Self

If possible, get a serialized error for failed argument lifts

impl PartialEq for CollectStrategy

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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<UT> TypeId<UT> for CollectStrategy

const TYPE_ID_META: MetadataBuffer = _

impl StructuralPartialEq for CollectStrategy