Struct ToDeviceRoomKeyWithheldEventContent

#[non_exhaustive]
pub struct ToDeviceRoomKeyWithheldEventContent {
    pub algorithm: EventEncryptionAlgorithm,
    pub code: RoomKeyWithheldCodeInfo,
    pub reason: Option<String>,
    pub sender_key: Base64,
}

The content of an m.room_key.withheld 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.

code: RoomKeyWithheldCodeInfo

A machine-readable code for why the megolm key was not sent.

reason: Option<String>

A human-readable reason for why the key was not sent.

The receiving client should only use this string if it does not understand the code.

sender_key: Base64

The unpadded base64-encoded device curve25519 key of the event’s sender.

Implementations

impl ToDeviceRoomKeyWithheldEventContent

pub fn new( algorithm: EventEncryptionAlgorithm, code: RoomKeyWithheldCodeInfo, sender_key: Base64, ) -> Self

Creates a new ToDeviceRoomKeyWithheldEventContent with the given algorithm, code and sender key.

Trait Implementations

impl Clone for ToDeviceRoomKeyWithheldEventContent

fn clone(&self) -> ToDeviceRoomKeyWithheldEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToDeviceRoomKeyWithheldEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToDeviceRoomKeyWithheldEventContent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToDeviceRoomKeyWithheldEventContent> for AnyToDeviceEventContent

fn from(c: ToDeviceRoomKeyWithheldEventContent) -> Self

Converts to this type from the input type.

impl Serialize for ToDeviceRoomKeyWithheldEventContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticEventContent for ToDeviceRoomKeyWithheldEventContent

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

The statically-known part of the event type.

type IsPrefix = False

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

impl ToDeviceEventContent for ToDeviceRoomKeyWithheldEventContent

fn event_type(&self) -> ToDeviceEventType

Get the event’s type, like m.room_key.

impl JsonCastable<AnyToDeviceEventContent> for ToDeviceRoomKeyWithheldEventContent

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