Struct RoomEncryptionEventContent

#[non_exhaustive]
pub struct RoomEncryptionEventContent {
    pub algorithm: EventEncryptionAlgorithm,
    pub encrypt_state_events: bool,
    pub rotation_period_ms: Option<UInt>,
    pub rotation_period_msgs: Option<UInt>,
}

The content of an m.room.encryption event.

Defines how messages sent in this room should be encrypted.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

algorithm: EventEncryptionAlgorithm

The encryption algorithm to be used to encrypt messages sent in this room.

Must be m.megolm.v1.aes-sha2.

encrypt_state_events: bool

Whether state events should be encrypted alongside message-like events.

rotation_period_ms: Option<UInt>

How long the session should be used before changing it.

uint!(604800000) (a week) is the recommended default.

rotation_period_msgs: Option<UInt>

How many messages should be sent before changing the session.

uint!(100) is the recommended default.

Implementations

impl RoomEncryptionEventContent

pub fn new(algorithm: EventEncryptionAlgorithm) -> Self

Creates a new RoomEncryptionEventContent with the given algorithm.

pub fn with_recommended_defaults() -> Self

Creates a new RoomEncryptionEventContent with the mandatory algorithm and the recommended defaults.

Note that changing the values of the fields is not a breaking change and you shouldn’t rely on those specific values.

pub fn with_encrypted_state(self) -> Self

Enable encrypted state as specified in MSC3414.

Trait Implementations

impl Clone for RoomEncryptionEventContent

fn clone(&self) -> RoomEncryptionEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoomEncryptionEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomEncryptionEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RoomEncryptionEventContent> for AnyStateEventContent

fn from(c: RoomEncryptionEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for RoomEncryptionEventContent

type Redacted = RedactedRoomEncryptionEventContent

The redacted form of the event’s content.

fn redact(self, _rules: &RedactionRules) -> RedactedRoomEncryptionEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomEncryptionEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomEncryptionEventContent

type StateKey = EmptyStateKey

The type of the event’s state_key field.

fn event_type(&self) -> StateEventType

Get the event’s type, like m.room.name.

impl StaticEventContent for RoomEncryptionEventContent

const TYPE: &'static str = "m.room.encryption"

The statically-known part of the event type.

type IsPrefix = False

Whether the statically-known part of the event type is the prefix.

impl StaticStateEventContent for RoomEncryptionEventContent

type PossiblyRedacted = PossiblyRedactedRoomEncryptionEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomEncryptionEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.

impl JsonCastable<AnyStateEventContent> for RoomEncryptionEventContent

impl JsonCastable<Map<String, Value>> for RoomEncryptionEventContent

impl JsonCastable<PossiblyRedactedRoomEncryptionEventContent> for RoomEncryptionEventContent

impl JsonCastable<RedactedRoomEncryptionEventContent> for RoomEncryptionEventContent