Enum HeadingDepth 

pub enum HeadingDepth {
    Docling,
    Source,
}

How a section_header’s level becomes a Pandoc Header depth (#848).

Variants

Docling

docling’s convention, the default: Header 1 is the document title and a section_header of level n is Header (n+1) (capped at 6), the depth docling’s Markdown and HTML serializers give it (## for level 1). The flat Node::Heading round trip relies on it — a level-2 heading is stored as a level-1 section_header and comes back as Header 2 — as do consumers of docling’s JSON, so it is not changed under them.

Source

The source’s own depth: a section_header of level n is Header n (clamped to 1–6; a missing or zero level is 1) and the title stays Header 1 — what Pandoc’s own docx / odt readers give (a DOCX Heading 1 is Header 1), so --number-sections, TOC depths and --shift-heading-level-by behave as on pandoc -f docx. A document whose backend reserves level 1 for the title (HTML, Markdown: an <h2> is a level-1 section_header) comes out one depth shallower under it.

Implementations

impl HeadingDepth

pub const NAMES: [&'static str; 2]

The spellings every surface accepts (docling = the default).

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

Trait Implementations

impl Clone for HeadingDepth

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HeadingDepth

impl Debug for HeadingDepth

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

Formats the value using the given formatter.

impl Default for HeadingDepth

fn default() -> Self

Returns the “default value” for a type.

impl Eq for HeadingDepth

impl FromStr for HeadingDepth

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, String>

Parses a string s to return a value of this type.

impl PartialEq for HeadingDepth

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HeadingDepth