Struct AdmonitionBlock 

pub struct AdmonitionBlock<'src> { /* private fields */ }

An admonition draws attention to a statement by taking it out of the content’s flow and labeling it with a priority (its type).

An admonition can be written in two ways:

• As a paragraph whose first line begins with one of the five admonition labels followed by a colon (e.g., NOTE: This is a note.). This produces an admonition with the Simple content model.
• As a block by setting one of the labels as the block style in an attribute list (e.g., [NOTE]). This is referred to as masquerading. When the style is set on a delimited block that can contain other blocks (such as an example block), the admonition uses the Compound content model; otherwise it uses the Simple content model.

Implementations

impl<'src> AdmonitionBlock<'src>

pub fn variant(&self) -> AdmonitionVariant

Returns the admonition type (e.g., AdmonitionVariant::Note).

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

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

pub fn label(&self) -> &str

Returns the caption (label) text shown for this admonition (e.g., Note).

This is the value of the <type>-caption document attribute if set, or the default caption for the admonition type otherwise.

pub fn icons_font(&self) -> bool

Returns true if font-based icons are enabled (i.e., the icons document attribute is set to font).

pub fn content(&self) -> Option<&Content<'src>>

Returns the simple content of this admonition, if it has the Simple content model.

Trait Implementations

impl<'src> Clone for AdmonitionBlock<'src>

fn clone(&self) -> AdmonitionBlock<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdmonitionBlock<'_>

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

Formats the value using the given formatter.

impl<'src> Eq for AdmonitionBlock<'src>

impl<'src> HasSpan<'src> for AdmonitionBlock<'src>

fn span(&self) -> Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> IsBlock<'src> for AdmonitionBlock<'src>

fn content_model(&self) -> ContentModel

Returns the ContentModel for this block.

fn raw_context(&self) -> CowStr<'src>

Returns the raw (uninterpreted) context for this block.

fn declared_style(&'src self) -> Option<&'src str>

Returns the declared (uninterpreted) style for this block.

fn rendered_content(&'src self) -> Option<&'src str>

Returns the rendered content for this block, if any.

fn nested_blocks(&'src self) -> Iter<'src, Block<'src>>

Returns an iterator over the nested blocks contained within this block.

fn nested_blocks_mut(&mut self) -> &mut [Block<'src>]

Returns a mutable slice of the nested blocks contained within this block.

fn content_mut(&mut self) -> Option<&mut Content<'src>>

Returns a mutable reference to this block’s own resolvable content — its body, section title, or description-list term — if any.

fn title_source(&'src self) -> Option<Span<'src>>

Returns the source text for the title for this block, if present.

fn title(&self) -> Option<&str>

Returns the rendered title for this block, if present.

fn anchor(&'src self) -> Option<Span<'src>>

Returns the anchor for this block, if present.

fn anchor_reftext(&'src self) -> Option<Span<'src>>

Returns the reference text for this block’s anchor, if present.

fn attrlist(&'src self) -> Option<&'src Attrlist<'src>>

Returns the attribute list for this block, if present.

fn resolved_context(&'src self) -> CowStr<'src>

Returns the resolved context for this block.

fn id(&'src self) -> Option<&'src str>

Returns the ID for this block, if present.

fn roles(&'src self) -> Vec<&'src str>

Returns any role attributes that were found.

fn options(&'src self) -> Vec<&'src str>

Returns any option attributes that were found.

fn has_option<N: AsRef<str>>(&'src self, name: N) -> bool

Returns true if this block has the named option.

fn caption(&self) -> Option<&str>

Returns the caption prefix for this block, if it has one.

fn number(&self) -> Option<usize>

Returns the automatically assigned number for this block, if it has one.

fn substitution_group(&'src self) -> SubstitutionGroup

Returns the default substitution group that is applied unless you customize the substitutions for a particular element.

impl<'src> PartialEq for AdmonitionBlock<'src>

fn eq(&self, other: &AdmonitionBlock<'src>) -> 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<'src> StructuralPartialEq for AdmonitionBlock<'src>