Struct TocBlock 

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

A TOC block represents the toc::[] block macro, which marks the position where a table of contents should be rendered when toc-placement is set to macro.

The macro carries no target; its optional attribute list can override the per-macro settings Asciidoctor honors on the generated TOC (id, levels, and role), while a block title above the macro overrides toc-title.

Implementations

impl<'src> TocBlock<'src>

pub fn child_blocks(&'src self) -> ChildBlocks<'src>

Returns a document-order iterator over this block’s direct child blocks.

A TOC block never has child blocks, so this iterator is always empty. See FindBlocks to search from a Block or Document.

pub fn macro_attrlist(&'src self) -> &'src Attrlist<'src>

Return the macro’s attribute list.

IMPORTANT: This is the list of attributes within the macro block definition itself (e.g. toc::[levels=2]), which Asciidoctor uses to override the per-macro TOC settings (id, levels, and role).

See also attrlist() for attributes that can be defined before the macro invocation.

Trait Implementations

impl<'src> Clone for TocBlock<'src>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for TocBlock<'src>

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

Formats the value using the given formatter.

impl<'src> Eq for TocBlock<'src>

impl<'src> HasSpan<'src> for TocBlock<'src>

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

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

impl<'src> Hash for TocBlock<'src>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'src> IsBlock<'src> for TocBlock<'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 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 id(&'src self) -> Option<&'src str>

Returns the ID 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 rendered_content(&'src self) -> Option<&'src str>

Returns the rendered content for this block, if any.

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

Returns the resolved context for this block.

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

Returns the declared (uninterpreted) style for this block.

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

Returns a mutable slice of the child 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 or description-list term – if any.

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 TocBlock<'src>

fn eq(&self, other: &TocBlock<'src>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'src> StructuralPartialEq for TocBlock<'src>