Struct ToDeviceRoomKeyEventContent

#[non_exhaustive]
pub struct ToDeviceRoomKeyEventContent {
    pub algorithm: EventEncryptionAlgorithm,
    pub room_id: OwnedRoomId,
    pub session_id: String,
    pub session_key: String,
    pub shared_history: bool,
}

Available on crate feature events only.

The content of an m.room_key event.

Typically encrypted as an m.room.encrypted event, then sent as a to-device event.

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 the key in this event is to be used with.

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

room_id: OwnedRoomId

The room where the key is used.

session_id: String

The ID of the session that the key is for.

session_key: String

The key to be exchanged.

shared_history: bool

Available on crate feature unstable-msc3061 only.

Used to mark key if allowed for shared history.

Defaults to false.

Implementations

impl ToDeviceRoomKeyEventContent

pub fn new( algorithm: EventEncryptionAlgorithm, room_id: OwnedRoomId, session_id: String, session_key: String, ) -> ToDeviceRoomKeyEventContent

Creates a new ToDeviceRoomKeyEventContent with the given algorithm, room ID, session ID and session key.

Trait Implementations

impl Clone for ToDeviceRoomKeyEventContent

fn clone(&self) -> ToDeviceRoomKeyEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToDeviceRoomKeyEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToDeviceRoomKeyEventContent

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToDeviceRoomKeyEventContent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for ToDeviceRoomKeyEventContent

type EventType = ToDeviceEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> <ToDeviceRoomKeyEventContent as EventContent>::EventType

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

impl From<ToDeviceRoomKeyEventContent> for AnyToDeviceEventContent

fn from(c: ToDeviceRoomKeyEventContent) -> AnyToDeviceEventContent

Converts to this type from the input type.

impl Serialize for ToDeviceRoomKeyEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for ToDeviceRoomKeyEventContent

const TYPE: &'static str = "m.room_key"

The event type.

impl ToDeviceEventContent for ToDeviceRoomKeyEventContent