ruma_events/
emote.rs

Help
1//! Types for extensible emote message events ([MSC3954]).
2//!
3//! [MSC3954]: https://github.com/matrix-org/matrix-spec-proposals/pull/3954
4
5use ruma_macros::EventContent;
6use serde::{Deserialize, Serialize};
7
8use super::{message::TextContentBlock, room::message::Relation};
9
10/// The payload for an extensible emote message.
11///
12/// This is the new primary type introduced in [MSC3954] and should only be sent in rooms with a
13/// version that supports it. See the documentation of the [`message`] module for more information.
14///
15/// To construct an `EmoteEventContent` with a custom [`TextContentBlock`], convert it with
16/// `EmoteEventContent::from()` / `.into()`.
17///
18/// [MSC3954]: https://github.com/matrix-org/matrix-spec-proposals/pull/3954
19/// [`message`]: super::message
20#[derive(Clone, Debug, Serialize, Deserialize, EventContent)]
21#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
22#[ruma_event(type = "org.matrix.msc1767.emote", kind = MessageLike, without_relation)]
23pub struct EmoteEventContent {
24    /// The message's text content.
25    #[serde(rename = "org.matrix.msc1767.text")]
26    pub text: TextContentBlock,
27
28    /// Whether this message is automated.
29    #[cfg(feature = "unstable-msc3955")]
30    #[serde(
31        default,
32        skip_serializing_if = "ruma_common::serde::is_default",
33        rename = "org.matrix.msc1767.automated"
34    )]
35    pub automated: bool,
36
37    /// Information about related messages.
38    #[serde(
39        flatten,
40        skip_serializing_if = "Option::is_none",
41        deserialize_with = "crate::room::message::relation_serde::deserialize_relation"
42    )]
43    pub relates_to: Option<Relation<EmoteEventContentWithoutRelation>>,
44}
45
46impl EmoteEventContent {
47    /// A convenience constructor to create a plain text emote.
48    pub fn plain(body: impl Into<String>) -> Self {
49        Self {
50            text: TextContentBlock::plain(body),
51            #[cfg(feature = "unstable-msc3955")]
52            automated: false,
53            relates_to: None,
54        }
55    }
56
57    /// A convenience constructor to create an HTML emote.
58    pub fn html(body: impl Into<String>, html_body: impl Into<String>) -> Self {
59        Self {
60            text: TextContentBlock::html(body, html_body),
61            #[cfg(feature = "unstable-msc3955")]
62            automated: false,
63            relates_to: None,
64        }
65    }
66
67    /// A convenience constructor to create an emote from Markdown.
68    ///
69    /// The content includes an HTML message if some Markdown formatting was detected, otherwise
70    /// only a plain text message is included.
71    #[cfg(feature = "markdown")]
72    pub fn markdown(body: impl AsRef<str> + Into<String>) -> Self {
73        Self {
74            text: TextContentBlock::markdown(body),
75            #[cfg(feature = "unstable-msc3955")]
76            automated: false,
77            relates_to: None,
78        }
79    }
80}
81
82impl From<TextContentBlock> for EmoteEventContent {
83    fn from(text: TextContentBlock) -> Self {
84        Self {
85            text,
86            #[cfg(feature = "unstable-msc3955")]
87            automated: false,
88            relates_to: None,
89        }
90    }
91}
ruma_events/emote.rs

ruma_events/
emote.rs
