pub struct FormattedBody {
pub format: MessageFormat,
pub body: String,
}
Available on crate feature
events
only.Expand description
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§
source§impl FormattedBody
impl FormattedBody
sourcepub fn html(body: impl Into<String>) -> FormattedBody
pub fn html(body: impl Into<String>) -> FormattedBody
Creates a new HTML-formatted message body.
sourcepub fn markdown(body: impl AsRef<str>) -> Option<FormattedBody>
Available on crate feature markdown
only.
pub fn markdown(body: impl AsRef<str>) -> Option<FormattedBody>
markdown
only.Creates a new HTML-formatted message body by parsing the Markdown in body
.
Returns None
if no Markdown formatting was found.
sourcepub fn sanitize_html(
&mut self,
mode: HtmlSanitizerMode,
remove_reply_fallback: RemoveReplyFallback,
)
Available on crate feature html
only.
pub fn sanitize_html( &mut self, mode: HtmlSanitizerMode, remove_reply_fallback: RemoveReplyFallback, )
html
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§
source§impl Clone for FormattedBody
impl Clone for FormattedBody
source§fn clone(&self) -> FormattedBody
fn clone(&self) -> FormattedBody
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for FormattedBody
impl Debug for FormattedBody
source§impl<'de> Deserialize<'de> for FormattedBody
impl<'de> Deserialize<'de> for FormattedBody
source§fn deserialize<__D>(
__deserializer: __D,
) -> Result<FormattedBody, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<FormattedBody, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl Serialize for FormattedBody
impl Serialize for FormattedBody
source§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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. Read more
Auto Trait Implementations§
impl Freeze for FormattedBody
impl RefUnwindSafe for FormattedBody
impl Send for FormattedBody
impl Sync for FormattedBody
impl Unpin for FormattedBody
impl UnwindSafe for FormattedBody
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more