Struct LongFormatText

#[non_exhaustive]
pub struct LongFormatText {
    pub plain_text: Option<String>,
    pub rich_text: Option<String>,
}

The text format for a subtitle.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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.

plain_text: Option<String>

Plain text format.

rich_text: Option<String>

Rich text. Examples of rich text include bold, underline, and italics.

Implementations

impl LongFormatText

pub fn plain_text(&self) -> Option<&str>

Plain text format.

pub fn rich_text(&self) -> Option<&str>

Rich text. Examples of rich text include bold, underline, and italics.

impl LongFormatText

pub fn builder() -> LongFormatTextBuilder

Creates a new builder-style object to manufacture LongFormatText.

Trait Implementations

impl Clone for LongFormatText

fn clone(&self) -> LongFormatText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LongFormatText

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

Formats the value using the given formatter.

impl PartialEq for LongFormatText

fn eq(&self, other: &LongFormatText) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LongFormatText