Struct EmoteEventContent

#[non_exhaustive]
pub struct EmoteEventContent {
    pub text: TextContentBlock,
    pub automated: bool,
    pub relates_to: Option<Relation<EmoteEventContentWithoutRelation>>,
}

Available on crate features events and unstable-msc3954 only.

The payload for an extensible emote message.

This is the new primary type introduced in MSC3954 and should only be sent in rooms with a version that supports it. See the documentation of the message module for more information.

To construct an EmoteEventContent with a custom TextContentBlock, convert it with EmoteEventContent::from() / .into().

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.

text: TextContentBlock

The message’s text content.

automated: bool

Available on crate feature unstable-msc3955 only.

Whether this message is automated.

relates_to: Option<Relation<EmoteEventContentWithoutRelation>>

Information about related messages.

Implementations

impl EmoteEventContent

pub fn plain(body: impl Into<String>) -> EmoteEventContent

A convenience constructor to create a plain text emote.

pub fn html( body: impl Into<String>, html_body: impl Into<String>, ) -> EmoteEventContent

A convenience constructor to create an HTML emote.

pub fn markdown(body: impl AsRef<str> + Into<String>) -> EmoteEventContent

Available on crate feature markdown only.

A convenience constructor to create an emote from Markdown.

The content includes an HTML message if some Markdown formatting was detected, otherwise only a plain text message is included.

Trait Implementations

impl Clone for EmoteEventContent

fn clone(&self) -> EmoteEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EmoteEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmoteEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for EmoteEventContent

type EventType = MessageLikeEventType

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

fn event_type(&self) -> <EmoteEventContent as EventContent>::EventType

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

impl From<EmoteEventContent> for AnyMessageLikeEventContent

fn from(c: EmoteEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl From<EmoteEventContent> for EmoteEventContentWithoutRelation

fn from(c: EmoteEventContent) -> EmoteEventContentWithoutRelation

Converts to this type from the input type.

impl From<TextContentBlock> for EmoteEventContent

fn from(text: TextContentBlock) -> EmoteEventContent

Converts to this type from the input type.

impl RedactContent for EmoteEventContent

type Redacted = RedactedEmoteEventContent

The redacted form of the event’s content.

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

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

impl Serialize for EmoteEventContent

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 EmoteEventContent

const TYPE: &'static str = "org.matrix.msc1767.emote"

The event type.

impl MessageLikeEventContent for EmoteEventContent