Struct RoomMessageEventContent
#[non_exhaustive]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 (Non-exhaustive)§
This struct is marked as non-exhaustive
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
impl RoomMessageEventContent
pub fn new(msgtype: MessageType) -> RoomMessageEventContent
pub fn new(msgtype: MessageType) -> RoomMessageEventContent
Create a RoomMessageEventContent
with the given MessageType
.
pub fn text_plain(body: impl Into<String>) -> RoomMessageEventContent
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
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
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
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
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
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
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
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
pub fn emote_markdown( body: impl AsRef<str> + Into<String>, ) -> RoomMessageEventContent
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,
) -> RoomMessageEventContent
pub fn make_reply_to<'a>( self, metadata: impl Into<ReplyMetadata<'a>>, forward_thread: ForwardThread, add_mentions: AddMentions, ) -> RoomMessageEventContent
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,
) -> RoomMessageEventContent
pub fn make_for_thread<'a>( self, metadata: impl Into<ReplyMetadata<'a>>, is_reply: ReplyWithinThread, add_mentions: AddMentions, ) -> RoomMessageEventContent
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>,
) -> RoomMessageEventContent
pub fn make_replacement( self, metadata: impl Into<ReplacementMetadata>, ) -> 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 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.
pub fn set_mentions(self, mentions: Mentions) -> RoomMessageEventContent
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
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
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 apply_replacement(
&mut self,
new_content: RoomMessageEventContentWithoutRelation,
)
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,
)
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
impl Clone for RoomMessageEventContent
§fn clone(&self) -> RoomMessageEventContent
fn clone(&self) -> RoomMessageEventContent
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for RoomMessageEventContent
impl Debug for RoomMessageEventContent
§impl<'de> Deserialize<'de> for RoomMessageEventContent
impl<'de> Deserialize<'de> for RoomMessageEventContent
§fn deserialize<D>(
deserializer: D,
) -> Result<RoomMessageEventContent, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<RoomMessageEventContent, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
§impl From<MessageType> for RoomMessageEventContent
impl From<MessageType> for RoomMessageEventContent
§fn from(msgtype: MessageType) -> RoomMessageEventContent
fn from(msgtype: MessageType) -> RoomMessageEventContent
§impl From<RoomMessageEventContent> for AnyMessageLikeEventContent
impl From<RoomMessageEventContent> for AnyMessageLikeEventContent
§fn from(c: RoomMessageEventContent) -> AnyMessageLikeEventContent
fn from(c: RoomMessageEventContent) -> AnyMessageLikeEventContent
§impl From<RoomMessageEventContent> for MessageType
impl From<RoomMessageEventContent> for MessageType
§fn from(content: RoomMessageEventContent) -> MessageType
fn from(content: RoomMessageEventContent) -> MessageType
§impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation
impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation
§fn from(
value: RoomMessageEventContent,
) -> RoomMessageEventContentWithoutRelation
fn from( value: RoomMessageEventContent, ) -> RoomMessageEventContentWithoutRelation
§impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent
impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent
§fn from(
value: RoomMessageEventContentWithoutRelation,
) -> RoomMessageEventContent
fn from( value: RoomMessageEventContentWithoutRelation, ) -> RoomMessageEventContent
§impl MessageLikeEventContent for RoomMessageEventContent
impl MessageLikeEventContent for RoomMessageEventContent
§fn event_type(&self) -> MessageLikeEventType
fn event_type(&self) -> MessageLikeEventType
m.room.message
.§impl RedactContent for RoomMessageEventContent
impl RedactContent for RoomMessageEventContent
§type Redacted = RedactedRoomMessageEventContent
type Redacted = RedactedRoomMessageEventContent
§fn redact(self, _rules: &RedactionRules) -> RedactedRoomMessageEventContent
fn redact(self, _rules: &RedactionRules) -> RedactedRoomMessageEventContent
self
into a redacted form (removing most or all fields) according to the spec. Read more§impl Serialize for RoomMessageEventContent
impl Serialize for RoomMessageEventContent
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
impl JsonCastable<AnyMessageLikeEventContent> for RoomMessageEventContent
impl JsonCastable<Map<String, Value>> for RoomMessageEventContent
impl JsonCastable<RedactedRoomMessageEventContent> for RoomMessageEventContent
Auto Trait Implementations§
impl Freeze for RoomMessageEventContent
impl RefUnwindSafe for RoomMessageEventContent
impl Send for RoomMessageEventContent
impl Sync for RoomMessageEventContent
impl Unpin for RoomMessageEventContent
impl UnwindSafe for RoomMessageEventContent
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> CompatExt for T
impl<T> CompatExt for T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> EventContentFromType for Twhere
T: StaticEventContent + DeserializeOwned,
impl<T> EventContentFromType for Twhere
T: StaticEventContent + DeserializeOwned,
Source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
Source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more