Struct ruma_common::events::secret::request::ToDeviceSecretRequestEventContent

#[non_exhaustive]
pub struct ToDeviceSecretRequestEventContent {
    pub action: RequestAction,
    pub requesting_device_id: OwnedDeviceId,
    pub request_id: OwnedTransactionId,
}

The content of an m.secret.request event.

Event sent by a client to request a secret from another device or to cancel a previous request.

It is sent as an unencrypted 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.

action: RequestAction

The action for the request.

requesting_device_id: OwnedDeviceId

The ID of the device requesting the event.

request_id: OwnedTransactionId

A random string uniquely identifying (with respect to the requester and the target) the target for a secret.

If the secret is requested from multiple devices at the same time, the same ID may be used for every target. The same ID is also used in order to cancel a previous request.

Implementations

impl ToDeviceSecretRequestEventContent

pub fn new(
    action: RequestAction,
    requesting_device_id: OwnedDeviceId,
    request_id: OwnedTransactionId
) -> Self

Creates a new ToDeviceRequestEventContent with the given action, requesting device ID and request ID.

Trait Implementations

impl Clone for ToDeviceSecretRequestEventContent

fn clone(&self) -> ToDeviceSecretRequestEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToDeviceSecretRequestEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToDeviceSecretRequestEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for ToDeviceSecretRequestEventContent

type EventType = ToDeviceEventType

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

fn event_type(&self) -> Self::EventType

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

impl From<ToDeviceSecretRequestEventContent> for AnyToDeviceEventContent

fn from(c: ToDeviceSecretRequestEventContent) -> Self

Converts to this type from the input type.

impl Serialize for ToDeviceSecretRequestEventContent

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 ToDeviceSecretRequestEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::ToDevice

The event’s “kind”.

const TYPE: &'static str = "m.secret.request"

The event type.