Struct SectionScanner 

pub struct SectionScanner { /* private fields */ }

Visitor that builds outline sections from body events. Tracks headings, links, tasks, and code blocks per section.

Implementations

impl SectionScanner

pub fn new() -> Self

pub fn into_sections(self) -> Vec<OutlineSection>

Consume and return all collected sections.

Trait Implementations

impl Default for SectionScanner

fn default() -> Self

Returns the “default value” for a type.

impl FileVisitor for SectionScanner

fn on_body_line( &mut self, raw: &str, cleaned: &str, line_num: usize, ) -> ScanAction

Called for each body line outside fenced code blocks and comment blocks.

fn on_code_fence_open( &mut self, _raw: &str, language: &str, _line_num: usize, ) -> ScanAction

Called when a fenced code block opens (e.g. ```rust).

fn on_frontmatter(&mut self, _props: IndexMap<String, Value>) -> ScanAction

Called with parsed frontmatter properties (empty IndexMap if none).

fn on_code_fence_close(&mut self, _line_num: usize) -> ScanAction

Called when a fenced code block closes.

fn on_code_block_line(&mut self, _raw: &str, _line_num: usize) -> ScanAction

Called for each line inside a fenced code block (between open/close fences). Default: no-op. Override this to receive code block content.

fn needs_body(&self) -> bool

Whether this visitor needs body events (on_body_line, on_code_block_line, on_code_fence_*). If false, the visitor only receives on_frontmatter and is then stopped. Default: true.

fn needs_frontmatter(&self) -> bool

Whether this visitor needs parsed frontmatter properties. If no visitor needs frontmatter, the scanner skips YAML accumulation and serde_saphyr parsing (but still reads past the --- delimiters). Default: true.