Enum OutlineNode 

pub enum OutlineNode {
    Tldr {
        path: NodePath,
        id: NodeId,
        title: String,
    },
    DocumentRoot {
        path: NodePath,
        id: NodeId,
        title: String,
        entry_summary: Option<EntrySummary>,
        children: Vec<OutlineNode>,
    },
    DocumentSection {
        path: NodePath,
        id: NodeId,
        title: String,
        entry_summary: Option<EntrySummary>,
        children: Vec<OutlineNode>,
    },
    DocumentEntry {

        owner: Box<ContentReveal>,
        path: NodePath,
        id: NodeId,
        title: String,
        entry_kind: EntryKind,
        case: NameCase,
        names: Vec<String>,
        alias_groups: Vec<Vec<String>>,
        alias_of: Option<NodeId>,
        forms: Vec<String>,
        document_targets: Vec<EntryDocumentTarget>,
        value_domain: Option<Box<EntryValueDomain>>,
        entry_summary: Option<EntrySummary>,
        children: Vec<OutlineNode>,
    
},
}

One uniquely addressable node in a query outline.

Variants

Tldr

Optional quick-reference node.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local identity.

title: String

Display title.

DocumentRoot

Addressable document content that precedes the first heading.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Virtual document-root identity.

title: String

Display title for the leading content.

entry_summary: Option<EntrySummary>

Recursive semantic entry coverage for this scope.

children: Vec<OutlineNode>

Nested semantic entries when explicitly expanded.

DocumentSection

One semantic document section.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local section identity.

title: String

Section heading text.

entry_summary: Option<EntrySummary>

Recursive semantic entry coverage owned directly by this section.

children: Vec<OutlineNode>

Nested section and entry nodes.

DocumentEntry

One source-neutral semantic definition.

Fields

owner: Box<ContentReveal>

Exact original list/definition item in the loaded document, independent of semantic IDs, display labels and filtered outline paths.

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local entry identity.

title: String

Primary display term.

entry_kind: EntryKind

Semantic category of the entry.

case: NameCase

Alias case-matching policy.

names: Vec<String>

Exact selectable names, not proof of behavioral equivalence.

alias_groups: Vec<Vec<String>>

Explicit owner-local equivalence groups; no default canonical member.

alias_of: Option<NodeId>

Explicit same-document entry relationship; bodies stay independent.

forms: Vec<String>

Author-written input forms.

document_targets: Vec<EntryDocumentTarget>

Exact cross-document destinations declared by linked entry terms.

value_domain: Option<Box<EntryValueDomain>>

Optional finite or cross-document value space.

entry_summary: Option<EntrySummary>

Recursive semantic entry coverage owned by this entry.

children: Vec<OutlineNode>

Nested entry nodes.

Implementations

impl OutlineNode

pub fn path(&self) -> &str

Return the canonical structural path.

pub fn id(&self) -> &str

Return the stable document-local identity.

pub fn title(&self) -> &str

Return the node’s display title.

pub fn children(&self) -> &[Self]

Return child nodes, or an empty slice for leaf variants.

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<'de> Deserialize<'de> for OutlineNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OutlineNode

impl JsonSchema for OutlineNode

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for OutlineNode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutlineNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OutlineNode