Struct DirectDeviceContent

#[non_exhaustive]
pub struct DirectDeviceContent {
    pub sender: OwnedUserId,
    pub ev_type: ToDeviceEventType,
    pub message_id: OwnedTransactionId,
    pub messages: BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

The description of the direct-to- device message.

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.

sender: OwnedUserId

The user ID of the sender.

ev_type: ToDeviceEventType

Event type for the message.

message_id: OwnedTransactionId

Unique utf8 string ID for the message, used for idempotency.

messages: BTreeMap<OwnedUserId, BTreeMap<DeviceIdOrAllDevices, Raw<AnyToDeviceEventContent>>>

The contents of the messages to be sent.

These are arranged in a map of user IDs to a map of device IDs to message bodies. The device ID may also be *, meaning all known devices for the user.

Implementations

impl DirectDeviceContent

pub fn new( sender: OwnedUserId, ev_type: ToDeviceEventType, message_id: OwnedTransactionId, ) -> DirectDeviceContent

Creates a new DirectDeviceContent with the given sender, ev_typeandmessage_id`.

Trait Implementations

impl Clone for DirectDeviceContent

fn clone(&self) -> DirectDeviceContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirectDeviceContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DirectDeviceContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DirectDeviceContent

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.