Struct RoomMessageEventContent

#[non_exhaustive]
pub struct RoomMessageEventContent {
    pub msgtype: MessageType,
    pub relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>,
    pub mentions: Option<Mentions>,
}

The content of an m.room.message event.

This event is used when sending messages in a room.

Messages are not limited to be text.

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.

msgtype: MessageType

A key which identifies the type of message being sent.

This also holds the specific content of each message.

relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>

Information about related messages.

mentions: Option<Mentions>

The mentions of this event.

This should always be set to avoid triggering the legacy mention push rules. It is recommended to use Self::set_mentions() to set this field, that will take care of populating the fields correctly if this is a replacement.

Implementations

impl RoomMessageEventContent

pub fn new(msgtype: MessageType) -> Self

Create a RoomMessageEventContent with the given MessageType.

pub fn text_plain(body: impl Into<String>) -> Self

A constructor to create a plain text message.

pub fn text_html(body: impl Into<String>, html_body: impl Into<String>) -> Self

A constructor to create an html message.

pub fn text_markdown(body: impl AsRef<str> + Into<String>) -> Self

A constructor to create a markdown message.

pub fn notice_plain(body: impl Into<String>) -> Self

A constructor to create a plain text notice.

pub fn notice_html( body: impl Into<String>, html_body: impl Into<String>, ) -> Self

A constructor to create an html notice.

pub fn notice_markdown(body: impl AsRef<str> + Into<String>) -> Self

A constructor to create a markdown notice.

pub fn emote_plain(body: impl Into<String>) -> Self

A constructor to create a plain text emote.

pub fn emote_html(body: impl Into<String>, html_body: impl Into<String>) -> Self

A constructor to create an html emote.

pub fn emote_markdown(body: impl AsRef<str> + Into<String>) -> Self

A constructor to create a markdown emote.

pub fn make_reply_to<'a>( self, metadata: impl Into<ReplyMetadata<'a>>, forward_thread: ForwardThread, add_mentions: AddMentions, ) -> Self

Turns self into a rich reply to the message using the given metadata.

Sets the in_reply_to field inside relates_to, and optionally the rel_type to m.thread if the metadata has a thread and ForwardThread::Yes is used.

If AddMentions::Yes is used, the sender in the metadata is added as a user mention.

pub fn make_for_thread<'a>( self, metadata: impl Into<ReplyMetadata<'a>>, is_reply: ReplyWithinThread, add_mentions: AddMentions, ) -> Self

Turns self into a new message for a thread, that is optionally a reply.

Looks for the thread in the given metadata. If it exists, this message will be in the same thread. If it doesn’t, a new thread is created with the event_id in the metadata as the root.

It also sets the in_reply_to field inside relates_to to point the event_id in the metadata. If ReplyWithinThread::Yes is used, the metadata should be constructed from the event to make a reply to, otherwise it should be constructed from the latest event in the thread.

If AddMentions::Yes is used, the sender in the metadata is added as a user mention.

pub fn make_replacement(self, metadata: impl Into<ReplacementMetadata>) -> Self

Turns self into a replacement (or edit) for a given message.

The first argument after self can be &OriginalRoomMessageEvent or &OriginalSyncRoomMessageEvent if you don’t want to create ReplacementMetadata separately before calling this function.

This takes the content and sets it in m.new_content, and modifies the content to include a fallback.

If this message contains Mentions, they are copied into m.new_content to keep the same mentions, but the ones in content are filtered with the ones in the ReplacementMetadata so only new mentions will trigger a notification.

Panics

Panics if self has a formatted_body with a format other than HTML.

pub fn set_mentions(self, mentions: Mentions) -> Self

👎Deprecated: Call add_mentions before adding the relation instead.

Set the mentions of this event.

If this event is a replacement, it will update the mentions both in the content and the m.new_content so only new mentions will trigger a notification. As such, this needs to be called after Self::make_replacement().

It is not recommended to call this method after one that sets mentions automatically, like Self::make_reply_to() as these will be overwritten. Self::add_mentions() should be used instead.

pub fn add_mentions(self, mentions: Mentions) -> Self

Add the given mentions to this event.

If no Mentions was set on this events, this sets it. Otherwise, this updates the current mentions by extending the previous user_ids with the new ones, and applies a logical OR to the values of room.

This should be called before methods that add a relation, like Self::make_reply_to() and Self::make_replacement(), for the mentions to be correctly set.

pub fn msgtype(&self) -> &str

Returns a reference to the msgtype string.

If you want to access the message type-specific data rather than the message type itself, use the msgtype field, not this method.

pub fn body(&self) -> &str

Return a reference to the message body.

pub fn apply_replacement( &mut self, new_content: RoomMessageEventContentWithoutRelation, )

Apply the given new content from a Replacement to this message.

pub fn sanitize( &mut self, mode: HtmlSanitizerMode, remove_reply_fallback: RemoveReplyFallback, )

Sanitize this message.

If this message contains HTML, this removes the tags and attributes that are not listed in the Matrix specification.

It can also optionally remove the rich reply fallback from the plain text and HTML message.

This method is only effective on text, notice and emote messages.

Trait Implementations

impl Clone for RoomMessageEventContent

fn clone(&self) -> RoomMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomMessageEventContent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomMessageEventContent

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<MessageType> for RoomMessageEventContent

fn from(msgtype: MessageType) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContent> for AnyMessageLikeEventContent

fn from(c: RoomMessageEventContent) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContent> for MessageType

fn from(content: RoomMessageEventContent) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation

fn from(value: RoomMessageEventContent) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent

fn from(value: RoomMessageEventContentWithoutRelation) -> Self

Converts to this type from the input type.

impl RedactContent for RoomMessageEventContent

type Redacted = RedactedRoomMessageEventContent

The redacted form of the event’s content.

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

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

impl Serialize for RoomMessageEventContent

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 RoomMessageEventContent

const TYPE: &'static str = "m.room.message"

The event type.

impl MessageLikeEventContent for RoomMessageEventContent