Enum ruma::events::room::message::MessageType

source ·
#[non_exhaustive]
pub enum MessageType { Audio(AudioMessageEventContent), Emote(EmoteMessageEventContent), File(FileMessageEventContent), Image(ImageMessageEventContent), Location(LocationMessageEventContent), Notice(NoticeMessageEventContent), ServerNotice(ServerNoticeMessageEventContent), Text(TextMessageEventContent), Video(VideoMessageEventContent), VerificationRequest(KeyVerificationRequestEventContent), }
Expand description

The content that is specific to each message type variant.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Audio(AudioMessageEventContent)

An audio message.

§

Emote(EmoteMessageEventContent)

An emote message.

§

File(FileMessageEventContent)

A file message.

§

Image(ImageMessageEventContent)

An image message.

§

Location(LocationMessageEventContent)

A location message.

§

Notice(NoticeMessageEventContent)

A notice message.

§

ServerNotice(ServerNoticeMessageEventContent)

A server notice message.

§

Text(TextMessageEventContent)

A text message.

§

Video(VideoMessageEventContent)

A video message.

§

VerificationRequest(KeyVerificationRequestEventContent)

A request to initiate a key verification.

Implementations§

source§

impl MessageType

source

pub fn new( msgtype: &str, body: String, data: Map<String, Value>, ) -> Result<MessageType, Error>

Creates a new MessageType.

The msgtype and body are required fields as defined by the m.room.message spec. Additionally it’s possible to add arbitrary key/value pairs to the event content for custom events through the data map.

Prefer to use the public variants of MessageType where possible; this constructor is meant be used for unsupported message types only and does not allow setting arbitrary data for supported ones.

§Errors

Returns an error if the msgtype is known and serialization of data to the corresponding MessageType variant fails.

source

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

A constructor to create a plain text message.

source

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

A constructor to create an html message.

source

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

A constructor to create a markdown message.

source

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

A constructor to create a plain text notice.

source

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

A constructor to create an html notice.

source

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

A constructor to create a markdown notice.

source

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

A constructor to create a plain text emote.

source

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

A constructor to create an html emote.

source

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

A constructor to create a markdown emote.

source

pub fn msgtype(&self) -> &str

Returns a reference to the msgtype string.

source

pub fn body(&self) -> &str

Return a reference to the message body.

source

pub fn data(&self) -> Cow<'_, Map<String, Value>>

Returns the associated data.

The returned JSON object won’t contain the msgtype and body fields, use .msgtype() / .body() to access those.

Prefer to use the public variants of MessageType where possible; this method is meant to be used for custom message types only.

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. Note that you should be sure that the message is a reply, as there is no way to differentiate plain text reply fallbacks and markdown quotes.

This method is only effective on text, notice and emote messages.

Trait Implementations§

source§

impl Clone for MessageType

source§

fn clone(&self) -> MessageType

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 MessageType

source§

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

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

impl<'de> Deserialize<'de> for MessageType

source§

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

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

impl From<MessageType> for RoomMessageEventContent

source§

fn from(msgtype: MessageType) -> RoomMessageEventContent

Converts to this type from the input type.
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 MessageType

source§

fn from(content: RoomMessageEventContent) -> MessageType

Converts to this type from the input type.
source§

impl Serialize for MessageType

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§

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

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

§

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