Enum CaptionKind 

#[non_exhaustive]
pub enum CaptionKind {
    Example,
    Figure,
    Listing,
    Table,
}

A block category with its own caption attribute and counter.

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.

Example

An example block or paragraph controlled by example-caption.

Figure

A block image controlled by figure-caption.

Listing

A listing or source block controlled by listing-caption.

Table

A table controlled by table-caption.

Implementations

impl CaptionKind

pub fn for_style(style: Option<&str>) -> Option<Self>

The caption category a [style] names on a paragraph, or on a delimiter that carries no context of its own.

Parsed blocks already carry their caption in BlockMetadata::caption; this is for a consumer classifying a block it built itself.

pub fn for_delimited( inner: &DelimitedBlockType<'_>, style: Option<&str>, ) -> Option<Self>

The caption category of a delimited block, from its delimiter and style.

Parsed blocks already carry their caption in BlockMetadata::caption; this is for a consumer classifying a block it built itself.

Trait Implementations

impl Clone for CaptionKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaptionKind

impl Debug for CaptionKind

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

Formats the value using the given formatter.

impl Eq for CaptionKind

impl PartialEq for CaptionKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaptionKind