Enum Block 

#[non_exhaustive]
pub enum Block {
    #[non_exhaustive]
    Text {
        content: String,
        footnotes: Vec<Footnote>,
    },
    #[non_exhaustive]
    Quote {
        content: String,
        footnotes: Vec<Footnote>,
    },
    #[non_exhaustive]
    Title {
        content: String,
        footnotes: Vec<Footnote>,
        level: usize,
    },
    #[non_exhaustive]
    Image {
        url: PathBuf,
        alt: Option<String>,
        caption: Option<String>,
        footnotes: Vec<Footnote>,
    },
    #[non_exhaustive]
    Audio {
        url: PathBuf,
        fallback: String,
        caption: Option<String>,
        footnotes: Vec<Footnote>,
    },
    #[non_exhaustive]
    Video {
        url: PathBuf,
        fallback: String,
        caption: Option<String>,
        footnotes: Vec<Footnote>,
    },
    #[non_exhaustive]
    MathML {
        element_str: String,
        fallback_image: Option<PathBuf>,
        caption: Option<String>,
        footnotes: Vec<Footnote>,
    },
}

Content Block

The content block is the basic unit of content in a content document. It can be one of the following types: Text, Quote, Title, Image, Audio, Video, MathML.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Text

Text paragraph

This block represents a paragraph of text.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

content: String

footnotes: Vec<Footnote>

#[non_exhaustive]

Quote

Quote paragraph

This block represents a paragraph of quoted text.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

content: String

footnotes: Vec<Footnote>

#[non_exhaustive]

Title

Heading

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

content: String

footnotes: Vec<Footnote>

level: usize

Heading level

The valid range is 1 to 6.

#[non_exhaustive]

Image

Image block

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

url: PathBuf

Image file path

alt: Option<String>

Alternative text for the image

caption: Option<String>

Caption for the image

footnotes: Vec<Footnote>

#[non_exhaustive]

Audio

Audio block

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

url: PathBuf

Audio file path

fallback: String

Fallback text for the audio

This is used when the audio file cannot be played.

caption: Option<String>

Caption for the audio

footnotes: Vec<Footnote>

#[non_exhaustive]

Video

Video block

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

url: PathBuf

Video file path

fallback: String

Fallback text for the video

This is used when the video file cannot be played.

caption: Option<String>

Caption for the video

footnotes: Vec<Footnote>

#[non_exhaustive]

MathML

MathML block

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

element_str: String

MathML element raw data

This field stores the raw data of the MathML markup, which we do not verify, and the user needs to make sure it is correct.

fallback_image: Option<PathBuf>

Fallback image for the MathML block

This field stores the path to the fallback image, which will be displayed when the MathML markup cannot be rendered.

caption: Option<String>

Caption for the MathML block

footnotes: Vec<Footnote>

Implementations

impl Block

pub fn take_footnotes(&self) -> Vec<Footnote>

Trait Implementations

impl Debug for Block

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

Formats the value using the given formatter.