Struct EncryptionSettings

pub struct EncryptionSettings {
    pub algorithm: EventEncryptionAlgorithm,
    pub rotation_period: u64,
    pub rotation_period_msgs: u64,
    pub history_visibility: HistoryVisibility,
    pub only_allow_trusted_devices: bool,
    pub error_on_verified_user_problem: bool,
}

Settings that should be used when a room key is shared.

These settings control which algorithm the room key should use, how long a room key should be used and some other important information that determines the lifetime of a room key.

Fields

algorithm: EventEncryptionAlgorithm

The encryption algorithm that should be used in the room.

rotation_period: u64

How long can the room key be used before it should be rotated. Time in seconds.

rotation_period_msgs: u64

How many messages should be sent before the room key should be rotated.

history_visibility: HistoryVisibility

The current history visibility of the room. The visibility will be tracked by the room key and the key will be rotated if the visibility changes.

only_allow_trusted_devices: bool

Should untrusted devices receive the room key, or should they be excluded from the conversation.

error_on_verified_user_problem: bool

Should fail to send when a verified user has unverified devices, or when a previously verified user replaces their identity.

Trait Implementations

impl<UT> ConvertError<UT> for EncryptionSettings

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

impl<UT> FfiConverter<UT> for EncryptionSettings

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a MetadataBuffer.

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.

impl From<EncryptionSettings> for EncryptionSettings

fn from(v: EncryptionSettings) -> Self

Converts to this type from the input type.

impl<UT> Lift<UT> for EncryptionSettings

type FfiType = <EncryptionSettings 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 EncryptionSettings

type LiftType = EncryptionSettings

impl<UT> LiftReturn<UT> for EncryptionSettings

type ReturnType = <EncryptionSettings 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 EncryptionSettings

type FfiType = <EncryptionSettings 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 EncryptionSettings

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for EncryptionSettings

type ReturnType = <EncryptionSettings 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<UT> TypeId<UT> for EncryptionSettings

const TYPE_ID_META: MetadataBuffer = _