Struct OutlineNode 

pub struct OutlineNode {
    pub path: String,
    pub label: Option<String>,
    pub children: Vec<OutlineNode>,
}

One node of a site’s spanning outline: the archive’s own containment hierarchy, materialized by whoever holds the workspace.

A vault’s spine is configured, not spelled: prov’s spanning: names the relation whose links contain, and contents:/part_of: is one vault dialect’s spelling of it. This crate cannot read a workspace’s configuration — it reads nothing — so the layer that can walks the tree and hands the result down as plain data. See SiteOptions::outline.

path is the source path in the coordinates SourceDoc::path is written in: rebased onto the site’s anchor, sanitized, carrying the body’s own extension. That is what lets a node be matched to the page it became without either side re-deriving the other’s naming rule.

A node naming a document this site does not publish is not an error and not a nav entry — it is pruned, and its published descendants hoist to the nearest ancestor that is published. Under explicit-only visibility that is the ordinary shape, not the edge case.

Fields

path: String

The source path this node names, spelled as SourceDoc::path spells it.

label: Option<String>

The label the containing document’s link carried ([Label](path)), when it carried one. A fallback only: a page’s own nav_title/title wins.

children: Vec<OutlineNode>

Contained nodes, in the order the containing document declared them.

Trait Implementations

impl Clone for OutlineNode

fn clone(&self) -> OutlineNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutlineNode

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

Formats the value using the given formatter.

impl Default for OutlineNode

fn default() -> OutlineNode

Returns the “default value” for a type.