Enum ruma_events::room::message::MessageType

#[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),
}

The content that is specific to each message type variant.

Variants (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

impl MessageType

pub fn new(msgtype: &str, body: String, data: JsonObject) -> Result<Self>

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.

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

A constructor to create a plain text message.

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

A constructor to create an html message.

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

A constructor to create a markdown message.

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

A constructor to create a plain text notice.

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

A constructor to create an html notice.

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

A constructor to create a markdown notice.

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

A constructor to create a plain text emote.

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

A constructor to create an html emote.

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

A constructor to create a markdown emote.

pub fn msgtype(&self) -> &str

Returns a reference to the msgtype string.

pub fn body(&self) -> &str

Return a reference to the message body.

pub fn data(&self) -> Cow<'_, JsonObject>

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.

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

impl Clone for MessageType

fn clone(&self) -> MessageType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageType

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MessageType> for RoomMessageEventContent

fn from(msgtype: MessageType) -> Self

Converts to this type from the input type.

impl From<MessageType> for RoomMessageEventContentWithoutRelation

fn from(msgtype: MessageType) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContent> for MessageType

fn from(content: RoomMessageEventContent) -> Self

Converts to this type from the input type.

impl Serialize for MessageType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.