Struct ruma::events::room::message::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) -> RoomMessageEventContent

Create a RoomMessageEventContent with the given MessageType.

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

A constructor to create a plain text message.

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

A constructor to create an html message.

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

A constructor to create a markdown message.

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

A constructor to create a plain text notice.

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

A constructor to create an html notice.

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

A constructor to create a markdown notice.

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

A constructor to create a plain text emote.

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

A constructor to create an html emote.

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

A constructor to create a markdown emote.

pub fn make_reply_to( self, original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>, forward_thread: ForwardThread, add_mentions: AddMentions, ) -> RoomMessageEventContent

Turns self into a reply to the given message.

Takes the body / formatted_body (if any) in self for the main text and prepends a quoted version of original_message. Also sets the in_reply_to field inside relates_to, and optionally the rel_type to m.thread if the `original_message is in a thread and thread forwarding is enabled.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the html feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

Panics

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

pub fn make_reply_to_raw( self, original_event: &Raw<AnySyncTimelineEvent>, original_event_id: OwnedEventId, room_id: &RoomId, forward_thread: ForwardThread, add_mentions: AddMentions, ) -> RoomMessageEventContent

Turns self into a reply to the given raw event.

Takes the body / formatted_body (if any) in self for the main text and prepends a quoted version of the body of original_event (if any). Also sets the in_reply_to field inside relates_to, and optionally the rel_type to m.thread if the `original_message is in a thread and thread forwarding is enabled.

It is recommended to use Self::make_reply_to() for replies to m.room.message events, as the generated fallback is better for some msgtypes.

Note that except for the panic below, this is infallible. Which means that if a field is missing when deserializing the data, the changes that require it will not be applied. It will still at least apply the m.in_reply_to relation to this content.

Panics

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

pub fn make_for_thread( self, previous_message: &OriginalMessageLikeEvent<RoomMessageEventContent>, is_reply: ReplyWithinThread, add_mentions: AddMentions, ) -> RoomMessageEventContent

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

Looks for a Relation::Thread in previous_message. If it exists, this message will be in the same thread. If it doesn’t, a new thread with previous_message as the root is created.

If this is a reply within the thread, takes the body / formatted_body (if any) in self for the main text and prepends a quoted version of previous_message. Also sets the in_reply_to field inside relates_to.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the html feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

Panics

Panics if this is a reply within the thread and self has a formatted_body with a format other than HTML.

pub fn make_replacement( self, metadata: impl Into<ReplacementMetadata>, replied_to_message: Option<&OriginalMessageLikeEvent<RoomMessageEventContent>>, ) -> RoomMessageEventContent

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 the message that is replaced is a reply to another message, the latter should also be provided to be able to generate a rich reply fallback that takes the body / formatted_body (if any) in self for the main text and prepends a quoted version of original_message.

This function requires an OriginalRoomMessageEvent since it creates a permalink to the previous message, for which the room ID is required. If you want to reply to an OriginalSyncRoomMessageEvent, you have to convert it first by calling .into_full_event().

If the message was edited, the previous message should be the original message that was edited, with the content of its replacement, to allow the fallback to be accurate at the time it is added.

It is recommended to enable the html feature when using this method as this will clean up nested rich reply fallbacks in chains of replies. This uses sanitize_html() internally, with RemoveReplyFallback::Yes.

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) -> RoomMessageEventContent

👎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) -> RoomMessageEventContent

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<RoomMessageEventContent, <D as Deserializer<'de>>::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) -> <RoomMessageEventContent as EventContent>::EventType

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

impl From<MessageType> for RoomMessageEventContent

fn from(msgtype: MessageType) -> RoomMessageEventContent

Converts to this type from the input type.

impl From<RoomMessageEventContent> for AnyMessageLikeEventContent

fn from(c: RoomMessageEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl From<RoomMessageEventContent> for MessageType

fn from(content: RoomMessageEventContent) -> MessageType

Converts to this type from the input type.

impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation

fn from( value: RoomMessageEventContent, ) -> RoomMessageEventContentWithoutRelation

Converts to this type from the input type.

impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent

fn from( value: RoomMessageEventContentWithoutRelation, ) -> RoomMessageEventContent

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 as Serializer>::Ok, <__S as Serializer>::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