Enum Caption 

#[non_exhaustive]
pub enum Caption<'a> {
    Numbered {
        kind: CaptionKind,
        label: Cow<'a, str>,
        number: Option<NonZeroU32>,
    },
    Custom(Cow<'a, str>),
    Unnumbered,
}

The caption a titled block takes.

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.

Numbered

A type-specific caption and its document-wide ordinal.

kind names the counter the ordinal came from. number is Some only for a block that had a title when ordinals were assigned; such a block consumed one ordinal from that counter. It is None for a block that had no title, which consumed nothing — a consumer that adds a title later either supplies its own ordinal or calls Document::renumber_captions.

Fields

kind: CaptionKind

The counter this caption draws its ordinal from.

label: Cow<'a, str>

The caption label, e.g. Example. Empty when the attribute is set with no value.

number: Option<NonZeroU32>

The document-wide ordinal, or None when the block had no title. Kept narrow because it sits on every block’s metadata.

Custom(Cow<'a, str>)

An explicit prefix, which takes no ordinal.

Unnumbered

Caption-capable, but no prefix applies.

Implementations

impl<'a> Caption<'a>

pub fn resolve( metadata: &BlockMetadata<'a>, attributes: &DocumentAttributes<'a>, kind: CaptionKind, ) -> Self

Resolve caption behavior from the block’s own attributes and the document attributes in effect at the block’s source position. Sets no ordinal.

impl Caption<'static>

pub fn resolve_owned( metadata: &BlockMetadata<'_>, attributes: &DocumentAttributes<'_>, kind: CaptionKind, ) -> Self

Caption::resolve for metadata and attributes whose lifetimes are unrelated, as a converter’s are: its stored attributes are independent of the borrowed document. Owns its strings, and sets no ordinal.

Trait Implementations

impl<'a> Clone for Caption<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Caption<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Caption<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Caption<'a>