Struct ToDeviceStreamCancelEventContent 

#[non_exhaustive]
pub struct ToDeviceStreamCancelEventContent {
    pub room_id: OwnedRoomId,
    pub event_id: OwnedEventId,
    pub subscriber_device_id: OwnedDeviceId,
    pub code: StreamCancelCode,
    pub reason: Option<String>,
}

Available on crate features events and unstable-msc4471 only.

The content of a to-device m.stream.cancel event.

Sent by either side of a subscription to cancel it.

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.

room_id: OwnedRoomId

The room containing the stream descriptor.

event_id: OwnedEventId

The event containing the stream descriptor.

subscriber_device_id: OwnedDeviceId

The subscriber device whose subscription is cancelled.

code: StreamCancelCode

A machine-readable cancellation code.

reason: Option<String>

A human-readable reason for debugging.

Clients should not rely on this value.

Implementations

impl ToDeviceStreamCancelEventContent

pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, subscriber_device_id: OwnedDeviceId, code: StreamCancelCode, ) -> ToDeviceStreamCancelEventContent

Creates a new ToDeviceStreamCancelEventContent with the given room, event, subscriber device, and code.

Trait Implementations

impl Clone for ToDeviceStreamCancelEventContent

fn clone(&self) -> ToDeviceStreamCancelEventContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToDeviceStreamCancelEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToDeviceStreamCancelEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToDeviceStreamCancelEventContent> for AnyToDeviceEventContent

fn from(c: ToDeviceStreamCancelEventContent) -> AnyToDeviceEventContent

Converts to this type from the input type.

impl Serialize for ToDeviceStreamCancelEventContent

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 ToDeviceStreamCancelEventContent

const TYPE: &'static str = "org.matrix.msc4471.stream.cancel"

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 ToDeviceStreamCancelEventContent

fn event_type(&self) -> ToDeviceEventType

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

impl JsonCastable<AnyToDeviceEventContent> for ToDeviceStreamCancelEventContent

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