Struct ruma_events::room::message::RoomMessageEventContent

source ·
pub struct RoomMessageEventContent {
    pub msgtype: MessageType,
    pub relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>,
    pub mentions: Option<Mentions>,
}
Expand description

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§

§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§

source§

impl RoomMessageEventContent

source

pub fn new(msgtype: MessageType) -> Self

Create a RoomMessageEventContent with the given MessageType.

source

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

A constructor to create a plain text message.

source

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

A constructor to create an html message.

source

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

A constructor to create a markdown message.

source

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

A constructor to create a plain text notice.

source

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

A constructor to create an html notice.

source

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

A constructor to create a markdown notice.

source

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

A constructor to create a plain text emote.

source

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

A constructor to create an html emote.

source

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

A constructor to create a markdown emote.

source

pub fn make_reply_to( self, original_message: &OriginalRoomMessageEvent, forward_thread: ForwardThread, add_mentions: AddMentions ) -> Self

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.

source

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

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.

source

pub fn make_for_thread( self, previous_message: &OriginalRoomMessageEvent, is_reply: ReplyWithinThread, add_mentions: AddMentions ) -> Self

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.

source

pub fn make_replacement( self, metadata: impl Into<ReplacementMetadata>, replied_to_message: Option<&OriginalRoomMessageEvent> ) -> 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 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.

source

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.

source

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.

source

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.

source

pub fn body(&self) -> &str

Return a reference to the message body.

source

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

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

source

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§

source§

impl Clone for RoomMessageEventContent

source§

fn clone(&self) -> RoomMessageEventContent

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for RoomMessageEventContent

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl EventContent for RoomMessageEventContent

§

type EventType = MessageLikeEventType

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

fn event_type(&self) -> Self::EventType

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

impl From<MessageType> for RoomMessageEventContent

source§

fn from(msgtype: MessageType) -> Self

Converts to this type from the input type.
source§

impl From<RoomMessageEventContent> for AnyMessageLikeEventContent

source§

fn from(c: RoomMessageEventContent) -> Self

Converts to this type from the input type.
source§

impl From<RoomMessageEventContent> for MessageType

source§

fn from(content: RoomMessageEventContent) -> Self

Converts to this type from the input type.
source§

impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation

source§

fn from(value: RoomMessageEventContent) -> Self

Converts to this type from the input type.
source§

impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent

source§

fn from(value: RoomMessageEventContentWithoutRelation) -> Self

Converts to this type from the input type.
source§

impl RedactContent for RoomMessageEventContent

§

type Redacted = RedactedRoomMessageEventContent

The redacted form of the event’s content.
source§

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

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

impl Serialize for RoomMessageEventContent

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl StaticEventContent for RoomMessageEventContent

source§

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

The event type.
source§

impl MessageLikeEventContent for RoomMessageEventContent

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> EventContentFromType for T

source§

fn from_parts(_event_type: &str, content: &RawValue) -> Result<T, Error>

Constructs this event content from the given event type and JSON.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,