Enum TocMode 

pub enum TocMode {
    Disabled,
    Auto,
    Left,
    Right,
    Preamble,
    Macro,
}

Where (and whether) a document’s table of contents (TOC) is generated, resolved from the toc attribute.

The toc attribute is header-only, so this value is fixed once a document’s header has been processed. A nested AsciiDoc table cell behaves as its own standalone document and resolves its own TocMode independently — it does not inherit the parent document’s setting.

The auto, left, and right placements all render the TOC automatically near the top of the document; left and right additionally request a fixed side column when converting to standalone HTML (a presentation detail outside this crate’s scope). preamble places the TOC immediately below the preamble, and macro defers placement to a toc::[] block macro.

Variants

Disabled

The toc attribute is unset: no table of contents is generated.

Auto

The toc attribute is empty (the value an empty :toc: resolves to) or set to auto. The TOC is generated automatically near the top of the document.

Left

The toc attribute is set to left: an automatically placed TOC that, in standalone HTML, is rendered as a fixed left-hand side column.

Right

The toc attribute is set to right: an automatically placed TOC that, in standalone HTML, is rendered as a fixed right-hand side column.

Preamble

The toc attribute is set to preamble: the TOC is generated immediately below the document’s preamble.

Macro

The toc attribute is set to macro: the table of contents is generated only where a toc::[] block macro appears.

Implementations

impl TocMode

pub fn is_enabled(self) -> bool

Returns true unless the toc attribute is unset (i.e. a table of contents is generated somewhere in the document).

Trait Implementations

impl Clone for TocMode

fn clone(&self) -> TocMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TocMode

impl Debug for TocMode

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

Formats the value using the given formatter.

impl Eq for TocMode

impl Hash for TocMode

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 PartialEq for TocMode

fn eq(&self, other: &TocMode) -> 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 TocMode