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),
    // some variants omitted
}

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: 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.

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<'_, 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.

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<(), Error>

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl From<MessageType> for RoomMessageEventContent

fn from(msgtype: MessageType) -> RoomMessageEventContent

Converts to this type from the input type.

impl Serialize for MessageType

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.