Struct TextRepresentation

#[non_exhaustive]
pub struct TextRepresentation {
    pub mimetype: String,
    pub body: String,
    pub lang: String,
}

Available on crate features events and unstable-msc1767 only.

Text content with optional markup.

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.

mimetype: String

The MIME type of the body.

This must follow the format defined in RFC6838.

body: String

The text content.

lang: String

Available on crate feature unstable-msc3554 only.

The language of the text (MSC3554).

This must be a valid language code according to BCP 47.

This is optional and defaults to en.

Implementations

impl TextRepresentation

pub fn new( mimetype: impl Into<String>, body: impl Into<String>, ) -> TextRepresentation

Creates a new TextRepresentation with the given MIME type and body.

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

Creates a new plain text message body.

pub fn html(body: impl Into<String>) -> TextRepresentation

Creates a new HTML-formatted message body.

pub fn markdown(body: impl AsRef<str>) -> Option<TextRepresentation>

Available on crate feature markdown only.

Creates a new HTML-formatted message body by parsing the Markdown in body.

Returns None if no Markdown formatting was found.

Trait Implementations

impl Clone for TextRepresentation

fn clone(&self) -> TextRepresentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextRepresentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextRepresentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<TextRepresentation> for TextContentBlock

fn from_iter<T>(iter: T) -> TextContentBlock

where T: IntoIterator<Item = TextRepresentation>,

Creates a value from an iterator.

impl Serialize for TextRepresentation

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.