Struct Document 

pub struct Document { /* private fields */ }

A parsed Markdown document: a preamble and a tree of sections.

Implementations

impl Document

pub fn parse(source: impl AsRef<str>) -> Self

Parse Markdown into a navigable document. Always succeeds: text with no headings is simply all preamble.

pub fn source(&self) -> &str

The document text exactly as given.

pub fn preamble(&self) -> &str

Content before the first heading. Skills often open with a sentence of orientation; this is it.

pub fn sections(&self) -> &[Section]

Top-level sections, in document order.

pub fn is_flat(&self) -> bool

Whether the document has no headings at all.

pub fn outline(&self) -> impl Iterator<Item = (usize, &Section)>

Every section, depth-first, paired with its nesting depth (0 at the top) — the shape of a table of contents.

let doc = Document::parse("# A\n## B\n# C\n");
let toc: Vec<_> = doc.outline().map(|(d, s)| (d, s.heading())).collect();
assert_eq!(toc, [(0, "A"), (1, "B"), (0, "C")]);

pub fn find(&self, slug: &str) -> Option<&Section>

Find a section by slug, at any depth.

pub fn section<'a>( &self, path: impl IntoIterator<Item = &'a str>, ) -> Option<&Section>

Follow a path of heading texts from the top: ["Deploy", "Rollback"] finds Rollback nested under Deploy. Matching ignores case and surrounding whitespace.

pub fn links(&self) -> Vec<Link>

Every inline link in the document, in order. Targets classified as LinkTarget::InPackage are the skill’s on-demand resources.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Display for Document

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

Formats the value using the given formatter.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document