Struct ruma_common::events::room::message::RoomMessageEventContent

#[non_exhaustive]
pub struct RoomMessageEventContent {
    pub msgtype: MessageType,
    pub relates_to: Option<Relation>,
}

The content of an m.room.message event.

This event is used when sending messages in a room.

Messages are not limited to be text.

Fields (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.

relates_to: Option<Relation>

Information about related messages for rich replies.

Implementations

impl RoomMessageEventContent

pub fn new(msgtype: MessageType) -> Self

Create a RoomMessageEventContent with the given MessageType.

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 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 text_reply_plain(
    reply: impl Display,
    original_message: &OriginalRoomMessageEvent
) -> Self

Creates a plain text reply to a message.

This constructor 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().

pub fn text_reply_html(
    reply: impl Display,
    html_reply: impl Display,
    original_message: &OriginalRoomMessageEvent
) -> Self

Creates a html text reply to a message.

This constructor 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().

pub fn notice_reply_plain(
    reply: impl Display,
    original_message: &OriginalRoomMessageEvent
) -> Self

Creates a plain text notice reply to a message.

This constructor 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().

pub fn notice_reply_html(
    reply: impl Display,
    html_reply: impl Display,
    original_message: &OriginalRoomMessageEvent
) -> Self

Creates a html text notice reply to a message.

This constructor 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().

pub fn msgtype(&self) -> &str

Returns a reference to the msgtype string.

If you want to access the message type-specific data rather than the message type itself, use the msgtype field, not this method.

pub fn body(&self) -> &str

Return a reference to the message body.

Trait Implementations

impl Clone for RoomMessageEventContent

fn clone(&self) -> RoomMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomMessageEventContent

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

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomMessageEventContent

type EventType = MessageLikeEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl From<MessageType> for RoomMessageEventContent

fn from(msgtype: MessageType) -> Self

Converts to this type from the input type.

impl From<RoomMessageEventContent> for AnyMessageLikeEventContent

fn from(c: RoomMessageEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for RoomMessageEventContent

type Redacted = RedactedRoomMessageEventContent

The redacted form of the event’s content.

fn redact(self, version: &RoomVersionId) -> RedactedRoomMessageEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomMessageEventContent

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

Serialize this value into the given Serde serializer.

impl StaticEventContent for RoomMessageEventContent

const KIND: EventKind = ::ruma_common::events::EventKind::MessageLike{redacted: false,}

The event’s “kind”.

const TYPE: &'static str = "m.room.message"

The event type.