Enum OutlineNodeReference 

pub enum OutlineNodeReference {
    Tldr {
        path: NodePath,
        id: NodeId,
        title: String,
    },
    DocumentRoot {
        path: NodePath,
        id: NodeId,
        title: String,
    },
    DocumentSection {
        path: NodePath,
        id: NodeId,
        title: String,
    },
    DocumentEntry {
        path: NodePath,
        id: NodeId,
        title: String,
        role: DefinitionRole,
        case: DefinitionCase,
        names: Vec<String>,
    },
}

Compact typed identity for the terminal node in an OutlineTrail.

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 content before the first heading.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Virtual document-root identity.

title: String

Display title.

DocumentSection

One semantic document section.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local identity.

title: String

Section heading text.

DocumentEntry

One semantic command, option, or variable definition.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local identity.

title: String

Primary display term.

role: DefinitionRole

Semantic category of the definition.

case: DefinitionCase

Alias case-matching policy.

names: Vec<String>

Normalized selectable aliases.

Implementations

impl OutlineNodeReference

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 display title.

Trait Implementations

impl Clone for OutlineNodeReference

fn clone(&self) -> OutlineNodeReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutlineNodeReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutlineNodeReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OutlineNodeReference

impl JsonSchema for OutlineNodeReference

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 OutlineNodeReference

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OutlineNodeReference

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 OutlineNodeReference