ruma::events::room::message

Struct RoomMessageEventContentWithoutRelation

Source
#[non_exhaustive]
pub struct RoomMessageEventContentWithoutRelation { pub msgtype: MessageType, pub mentions: Option<Mentions>, }
Available on crate feature events only.
Expand description

Form of RoomMessageEventContent without relation.

Fields (Non-exhaustive)§

This struct is marked as 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.

§mentions: Option<Mentions>

The mentions of this event.

Implementations§

Source§

impl RoomMessageEventContentWithoutRelation

Source

pub fn new(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation

Creates a new RoomMessageEventContentWithoutRelation with the given MessageType.

Source

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

A constructor to create a plain text message.

Source

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

A constructor to create an html message.

Source

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

Available on crate feature markdown only.

A constructor to create a markdown message.

Source

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

A constructor to create a plain text notice.

Source

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

A constructor to create an html notice.

Source

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

Available on crate feature markdown only.

A constructor to create a markdown notice.

Source

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

A constructor to create a plain text emote.

Source

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

A constructor to create an html emote.

Source

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

Available on crate feature markdown only.

A constructor to create a markdown emote.

Source

pub fn with_relation( self, relates_to: Option<Relation<RoomMessageEventContentWithoutRelation>>, ) -> RoomMessageEventContent

Transform self into a RoomMessageEventContent with the given relation.

Source

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.

Source

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.

Source

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.

Source

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

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.

Trait Implementations§

Source§

impl Clone for RoomMessageEventContentWithoutRelation

Source§

fn clone(&self) -> RoomMessageEventContentWithoutRelation

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 RoomMessageEventContentWithoutRelation

Source§

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

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

impl<'de> Deserialize<'de> for RoomMessageEventContentWithoutRelation

Source§

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

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

impl From<MessageType> for RoomMessageEventContentWithoutRelation

Source§

fn from(msgtype: MessageType) -> RoomMessageEventContentWithoutRelation

Converts to this type from the input type.
Source§

impl From<RoomMessageEventContent> for RoomMessageEventContentWithoutRelation

Source§

fn from( value: RoomMessageEventContent, ) -> RoomMessageEventContentWithoutRelation

Converts to this type from the input type.
Source§

impl From<RoomMessageEventContentWithoutRelation> for RoomMessageEventContent

Source§

fn from( value: RoomMessageEventContentWithoutRelation, ) -> RoomMessageEventContent

Converts to this type from the input type.
Source§

impl Serialize for RoomMessageEventContentWithoutRelation

Source§

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. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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,

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§

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§

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

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

Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T