Struct matrix_sdk::ruma::events::room::message::RoomMessageEventContentWithoutRelation
source · #[non_exhaustive]pub struct RoomMessageEventContentWithoutRelation {
pub msgtype: MessageType,
pub mentions: Option<Mentions>,
}
Expand description
Form of RoomMessageEventContent
without relation.
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.
mentions: Option<Mentions>
The mentions of this event.
Implementations§
source§impl RoomMessageEventContentWithoutRelation
impl RoomMessageEventContentWithoutRelation
sourcepub fn new(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation
pub fn new(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation
Creates a new RoomMessageEventContentWithoutRelation
with the given MessageType
.
sourcepub fn text_plain(
body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn text_plain( body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a plain text message.
sourcepub fn text_html(
body: impl Into<String>,
html_body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn text_html( body: impl Into<String>, html_body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create an html message.
sourcepub fn text_markdown(
body: impl AsRef<str> + Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn text_markdown( body: impl AsRef<str> + Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a markdown message.
sourcepub fn notice_plain(
body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn notice_plain( body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a plain text notice.
sourcepub fn notice_html(
body: impl Into<String>,
html_body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn notice_html( body: impl Into<String>, html_body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create an html notice.
sourcepub fn notice_markdown(
body: impl AsRef<str> + Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn notice_markdown( body: impl AsRef<str> + Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a markdown notice.
sourcepub fn emote_plain(
body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn emote_plain( body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a plain text emote.
sourcepub fn emote_html(
body: impl Into<String>,
html_body: impl Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn emote_html( body: impl Into<String>, html_body: impl Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create an html emote.
sourcepub fn emote_markdown(
body: impl AsRef<str> + Into<String>,
) -> RoomMessageEventContentWithoutRelation
pub fn emote_markdown( body: impl AsRef<str> + Into<String>, ) -> RoomMessageEventContentWithoutRelation
A constructor to create a markdown emote.
sourcepub fn with_relation(
self,
relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>,
) -> RoomMessageEventContent
pub fn with_relation( self, relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>, ) -> RoomMessageEventContent
Transform self
into a RoomMessageEventContent
with the given relation.
sourcepub fn make_reply_to(
self,
original_message: &OriginalMessageLikeEvent<RoomMessageEventContent>,
forward_thread: ForwardThread,
add_mentions: AddMentions,
) -> RoomMessageEventContent
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.
sourcepub fn make_reply_to_raw(
self,
original_event: &Raw<AnySyncTimelineEvent>,
original_event_id: OwnedEventId,
room_id: &RoomId,
forward_thread: ForwardThread,
add_mentions: AddMentions,
) -> RoomMessageEventContent
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 msgtype
s.
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.
sourcepub fn make_for_thread(
self,
previous_message: &OriginalMessageLikeEvent<RoomMessageEventContent>,
is_reply: ReplyWithinThread,
add_mentions: AddMentions,
) -> RoomMessageEventContent
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.
sourcepub fn make_replacement(
self,
metadata: impl Into<ReplacementMetadata>,
replied_to_message: Option<&OriginalMessageLikeEvent<RoomMessageEventContent>>,
) -> RoomMessageEventContent
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.
sourcepub fn add_mentions(
self,
mentions: Mentions,
) -> RoomMessageEventContentWithoutRelation
pub fn add_mentions( self, mentions: Mentions, ) -> RoomMessageEventContentWithoutRelation
Trait Implementations§
source§impl Clone for RoomMessageEventContentWithoutRelation
impl Clone for RoomMessageEventContentWithoutRelation
source§fn clone(&self) -> RoomMessageEventContentWithoutRelation
fn clone(&self) -> RoomMessageEventContentWithoutRelation
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl<'de> Deserialize<'de> for RoomMessageEventContentWithoutRelation
impl<'de> Deserialize<'de> for RoomMessageEventContentWithoutRelation
source§fn deserialize<D>(
deserializer: D,
) -> Result<RoomMessageEventContentWithoutRelation, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D,
) -> Result<RoomMessageEventContentWithoutRelation, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl From<MessageType> for RoomMessageEventContentWithoutRelation
impl From<MessageType> for RoomMessageEventContentWithoutRelation
source§fn from(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation
fn from(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation
source§impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation
impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation
source§fn from(
value: RoomMessageEventContent,
) -> RoomMessageEventContentWithoutRelation
fn from( value: RoomMessageEventContent, ) -> RoomMessageEventContentWithoutRelation
source§impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent
impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent
source§fn from(
value: RoomMessageEventContentWithoutRelation,
) -> RoomMessageEventContent
fn from( value: RoomMessageEventContentWithoutRelation, ) -> RoomMessageEventContent
source§impl Serialize for RoomMessageEventContentWithoutRelation
impl Serialize for RoomMessageEventContentWithoutRelation
source§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,
Auto Trait Implementations§
impl Freeze for RoomMessageEventContentWithoutRelation
impl RefUnwindSafe for RoomMessageEventContentWithoutRelation
impl Send for RoomMessageEventContentWithoutRelation
impl Sync for RoomMessageEventContentWithoutRelation
impl Unpin for RoomMessageEventContentWithoutRelation
impl UnwindSafe for RoomMessageEventContentWithoutRelation
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,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§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