Struct NoticeMessageEventContent

#[non_exhaustive]
pub struct NoticeMessageEventContent {
    pub body: String,
    pub formatted: Option<FormattedBody>,
}

Available on crate feature events only.

The payload for a notice message.

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.

body: String

The notice text.

formatted: Option<FormattedBody>

Formatted form of the message body.

Implementations

impl NoticeMessageEventContent

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

A convenience constructor to create a plain text notice.

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

A convenience constructor to create an html notice.

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

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 NoticeMessageEventContent

fn clone(&self) -> NoticeMessageEventContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoticeMessageEventContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NoticeMessageEventContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NoticeMessageEventContent

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.