Struct CaptionContentBlock

#[non_exhaustive]
pub struct CaptionContentBlock {
    pub text: TextContentBlock,
}

Available on crate features events and unstable-msc3551 only.

A block for caption content.

A caption is usually a text message that should be displayed next to some media content.

To construct a CaptionContentBlock with a custom TextContentBlock, convert it with CaptionContentBlock::from() / .into().

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.

text: TextContentBlock

The text message of the caption.

Implementations

impl CaptionContentBlock

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

A convenience constructor to create a plain text caption content block.

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

A convenience constructor to create an HTML caption content block.

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

Available on crate feature markdown only.

A convenience constructor to create a caption content block from Markdown.

The content includes an HTML message if some Markdown formatting was detected, otherwise only a plain text message is included.

Trait Implementations

impl Clone for CaptionContentBlock

fn clone(&self) -> CaptionContentBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CaptionContentBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CaptionContentBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TextContentBlock> for CaptionContentBlock

fn from(text: TextContentBlock) -> CaptionContentBlock

Converts to this type from the input type.

impl Serialize for CaptionContentBlock

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.