Struct ruma::events::notice::NoticeEventContent

pub struct NoticeEventContent {
    pub message: MessageContent,
    pub relates_to: Option<Relation<NoticeEventContentWithoutRelation>>,
}

Available on crate features events and unstable-msc1767 only.

The payload for an extensible notice message.

This is the new primary type introduced in MSC1767 and should not be sent before the end of the transition period. See the documentation of the message module for more information.

Fields

message: MessageContent

The message’s text content.

relates_to: Option<Relation<NoticeEventContentWithoutRelation>>

Information about related messages.

Implementations

impl NoticeEventContent

pub fn plain(body: impl Into<String>) -> NoticeEventContent

A convenience constructor to create a plain text notice.

pub fn html(
    body: impl Into<String>,
    html_body: impl Into<String>
) -> NoticeEventContent

A convenience constructor to create an HTML notice.

pub fn markdown(body: impl AsRef<str> + Into<String>) -> NoticeEventContent

Available on crate feature markdown only.

A convenience constructor to create a Markdown notice.

Returns an HTML notice if some Markdown formatting was detected, otherwise returns a plain text notice.

Trait Implementations

impl Clone for NoticeEventContent

fn clone(&self) -> NoticeEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoticeEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NoticeEventContent

fn deserialize<__D>(
    __deserializer: __D
) -> Result<NoticeEventContent, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for NoticeEventContent

type EventType = MessageLikeEventType

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

fn event_type(&self) -> <NoticeEventContent as EventContent>::EventType

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

impl From<NoticeEventContent> for AnyMessageLikeEventContent

fn from(c: NoticeEventContent) -> AnyMessageLikeEventContent

Converts to this type from the input type.

impl From<NoticeEventContent> for NoticeEventContentWithoutRelation

fn from(c: NoticeEventContent) -> NoticeEventContentWithoutRelation

Converts to this type from the input type.

impl RedactContent for NoticeEventContent

type Redacted = RedactedNoticeEventContent

The redacted form of the event’s content.

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

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

impl Serialize for NoticeEventContent

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.

impl StaticEventContent for NoticeEventContent

const TYPE: &'static str = "m.notice"

The event type.

impl MessageLikeEventContent for NoticeEventContent