Struct ruma::events::room::message::FormattedBody

pub struct FormattedBody {
    pub format: MessageFormat,
    pub body: String,
}

Available on crate feature events only.

Common message event content fields for message types that have separate plain-text and formatted representations.

Fields

format: MessageFormat

The format used in the formatted_body.

body: String

The formatted version of the body.

Implementations

impl FormattedBody

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

Creates a new HTML-formatted message body.

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

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.

pub fn sanitize_html(
    &mut self,
    mode: HtmlSanitizerMode,
    remove_reply_fallback: RemoveReplyFallback
)

Available on crate feature unstable-sanitize only.

Sanitize this FormattedBody if its format is MessageFormat::Html.

This removes any tags and attributes that are not listed in the Matrix specification.

It can also optionally remove the rich reply fallback.

Returns the sanitized HTML if the format is MessageFormat::Html.

Trait Implementations

impl Clone for FormattedBody

fn clone(&self) -> FormattedBody

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormattedBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FormattedBody

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

Deserialize this value from the given Serde deserializer.

impl Serialize for FormattedBody

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.