Enum ExcerptSelection 

pub enum ExcerptSelection {
    Tldr {
        outline: OutlineTrail,
        document: TldrDocument,
    },
    DocumentRoot {
        outline: OutlineTrail,
        heading: Option<Heading>,
        blocks: Vec<Block>,
    },
    DocumentSection {
        outline: OutlineTrail,
        section: Section,
    },
    DocumentEntry {
        outline: OutlineTrail,
        entry: Block,
    },
}

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

Variants

Tldr

Optional quick-reference content preceding the primary document.

Fields

outline: OutlineTrail

Complete logical location in the document outline.

document: TldrDocument

Complete quick-reference content.

DocumentRoot

Complete document content that appears before the first heading.

Fields

outline: OutlineTrail

Complete logical location in the document outline.

heading: Option<Heading>

Original visible document title, not a generated report label.

blocks: Vec<Block>

Complete leading blocks.

DocumentSection

Complete selected document node, including all descendant sections.

Fields

outline: OutlineTrail

Complete logical location in the document outline.

section: Section

Complete selected section including descendants.

DocumentEntry

One addressable owner with its complete, original content.

Fields

outline: OutlineTrail

Complete logical location in the document outline.

entry: Block

A single-item list or definition list, retaining original layout and numbering. Its sole item owns the entry facts; no body is rewritten.

Implementations

impl ExcerptSelection

pub const fn outline(&self) -> &OutlineTrail

Return the complete logical location of this selection.

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