Skip to main content

IndexNode

Enum IndexNode 

Source
pub enum IndexNode {
    Heading {
        level: u8,
        text: String,
    },
    Paragraph(String),
    Link(Link),
    List {
        ordered: bool,
        items: Vec<String>,
    },
    CodeBlock {
        language: Option<String>,
        code: String,
    },
    Table {
        rows: Vec<Vec<String>>,
    },
    Spacer {
        lines: u8,
    },
    Section {
        role: SectionRole,
        title: Option<String>,
        collapsed: bool,
        nodes: Vec<IndexNode>,
    },
    Image {
        alt: String,
        src: Option<String>,
    },
    Form(Form),
    Error(String),
}
Expand description

A semantic terminal-native node.

Variants§

§

Heading

Heading with one-based level.

Fields

§level: u8

One-based heading level.

§text: String

Heading text content.

§

Paragraph(String)

Paragraph text.

Link with stable display address.

§

List

Ordered or unordered list.

Fields

§ordered: bool

Whether numbering is semantic (true) or bullet-style (false).

§items: Vec<String>

Ordered display items.

§

CodeBlock

Code block.

Fields

§language: Option<String>

Optional declared language identifier.

§code: String

Code content.

§

Table

Table represented as rows of cells.

Fields

§rows: Vec<Vec<String>>

Rows of cells in display order.

§

Spacer

Vertical rhythm hint derived from semantic block boundaries or bounded CSS spacing.

Fields

§lines: u8

Extra blank terminal lines to preserve, clamped by producers.

§

Section

Semantic page region, usually collapsed when it is secondary to the main content.

Fields

§role: SectionRole

Region role inferred from HTML landmarks or common page conventions.

§title: Option<String>

Optional region title.

§collapsed: bool

Whether renderers should initially summarize rather than expand the region.

§nodes: Vec<IndexNode>

Region contents.

§

Image

Image proxy. The renderer decides how to display it.

Fields

§alt: String

Image alternate text.

§src: Option<String>

Optional source URL.

§

Form(Form)

Web form represented as terminal action fields.

§

Error(String)

Recoverable error displayed to the user.

Trait Implementations§

Source§

impl Clone for IndexNode

Source§

fn clone(&self) -> IndexNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IndexNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for IndexNode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for IndexNode

Source§

impl StructuralPartialEq for IndexNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.