Enum AdmonitionVariant 

pub enum AdmonitionVariant {
    Note,
    Tip,
    Important,
    Caution,
    Warning,
}

The five admonition types provided by the AsciiDoc language.

An admonition draws attention to a statement by taking it out of the content’s flow and labeling it with a priority. The variant is determined by the assigned type (i.e., the uppercase label), which is specified either as a special paragraph prefix (e.g., NOTE:) or as the block style in an attribute list (e.g., [NOTE]).

Variants

Note

The NOTE admonition type.

Tip

The TIP admonition type.

Important

The IMPORTANT admonition type.

Caution

The CAUTION admonition type.

Warning

The WARNING admonition type.

Implementations

impl AdmonitionVariant

pub fn style(self) -> &'static str

Returns the uppercase style label for this variant (e.g., NOTE).

pub fn name(self) -> &'static str

Returns the lowercase name for this variant (e.g., note).

This is the name used for the block’s CSS class and for the <type>-caption document attribute that controls the label text.

pub fn default_caption(self) -> &'static str

Returns the default caption (label) text for this variant (e.g., Note).

This text is shown to the reader (in place of an icon) unless it is overridden by setting the <type>-caption document attribute.

Trait Implementations

impl Clone for AdmonitionVariant

fn clone(&self) -> AdmonitionVariant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AdmonitionVariant

impl Debug for AdmonitionVariant

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

Formats the value using the given formatter.

impl Eq for AdmonitionVariant

impl PartialEq for AdmonitionVariant

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

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

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 AdmonitionVariant