Struct ruma_common::events::key::verification::cancel::KeyVerificationCancelEventContent

#[non_exhaustive]
pub struct KeyVerificationCancelEventContent {
    pub reason: String,
    pub code: CancelCode,
    pub relates_to: Relation,
}

The content of an in-room m.key.verification.cancel event.

Cancels a key verification process/request.

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.

reason: String

A human readable description of the code.

The client should only rely on this string if it does not understand the code.

code: CancelCode

The error code for why the process/request was cancelled by the user.

relates_to: Relation

Information about the related event.

Implementations

impl KeyVerificationCancelEventContent

pub fn new(reason: String, code: CancelCode, relates_to: Relation) -> Self

Creates a new KeyVerificationCancelEventContent with the given reason, code and relation.

Trait Implementations

impl Clone for KeyVerificationCancelEventContent

fn clone(&self) -> KeyVerificationCancelEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyVerificationCancelEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyVerificationCancelEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for KeyVerificationCancelEventContent

type EventType = MessageLikeEventType

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<KeyVerificationCancelEventContent> for AnyMessageLikeEventContent

fn from(c: KeyVerificationCancelEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for KeyVerificationCancelEventContent

type Redacted = RedactedKeyVerificationCancelEventContent

The redacted form of the event’s content.

fn redact(
    self,
    version: &RoomVersionId
) -> RedactedKeyVerificationCancelEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for KeyVerificationCancelEventContent

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 KeyVerificationCancelEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::MessageLike{redacted: false,}

The event’s “kind”.

const TYPE: &'static str = "m.key.verification.cancel"

The event type.