Enum ExcerptSelection 

pub enum ExcerptSelection {
    Tldr {
        path: NodePath,
        id: NodeId,
        title: String,
        document: TldrDocument,
    },
    DocumentRoot {
        path: NodePath,
        id: NodeId,
        title: String,
        blocks: Vec<Block>,
    },
    DocumentSection {
        path: NodePath,
        id: NodeId,
        title: String,
        breadcrumbs: Vec<OutlineReference>,
        section: Section,
    },
    DocumentEntry {
        path: NodePath,
        id: NodeId,
        title: String,
        breadcrumbs: Vec<OutlineReference>,
        entry: DefinitionItem,
    },
}

One selected document node together with its location in the complete outline.

Variants

Tldr

Optional quick-reference content preceding the primary document.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local identity.

title: String

Display title.

document: TldrDocument

Complete quick-reference content.

DocumentRoot

Complete document content that appears before the first heading.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Virtual document-root identity.

title: String

Display title for the leading content.

blocks: Vec<Block>

Complete leading blocks.

DocumentSection

Complete selected document node, including all descendant sections.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local section identity.

title: String

Section heading text.

breadcrumbs: Vec<OutlineReference>

Ordered ancestors from the document root to the parent section.

section: Section

Complete selected section including descendants.

DocumentEntry

One addressable semantic definition and its complete description.

Fields

path: NodePath

Canonical structural outline path.

id: NodeId

Stable document-local entry identity.

title: String

Primary display term.

breadcrumbs: Vec<OutlineReference>

Ordered containing sections from outermost to innermost.

entry: DefinitionItem

Complete semantic definition.

Trait Implementations

impl Clone for ExcerptSelection

fn clone(&self) -> ExcerptSelection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExcerptSelection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExcerptSelection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExcerptSelection

impl JsonSchema for ExcerptSelection

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 ExcerptSelection

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExcerptSelection

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 ExcerptSelection