Skip to main content

NodeContent

html_to_markdown_rs::types

Enum NodeContent

pub enum NodeContent {
Show 13 variants    Heading {
        level: u8,
        text: String,
    },
    Paragraph {
        text: String,
    },
    List {
        ordered: bool,
    },
    ListItem {
        text: String,
    },
    Table {
        grid: TableGrid,
    },
    Image {
        description: Option<String>,
        src: Option<String>,
        image_index: Option<u32>,
    },
    Code {
        text: String,
        language: Option<String>,
    },
    Quote,
    DefinitionList,
    DefinitionItem {
        term: String,
        definition: String,
    },
    RawBlock {
        format: String,
        content: String,
    },
    MetadataBlock {
        entries: Vec<(String, String)>,
    },
    Group {
        label: Option<String>,
        heading_level: Option<u8>,
        heading_text: Option<String>,
    },
}

Expand description

The semantic content type of a document node.

Uses internally tagged representation ("node_type": "heading") for JSON serialization.

Variants§

Heading

A heading element (h1-h6).

Fields

§level: u8

Heading level (1-6).

§text: String

The heading text content.

Paragraph

A paragraph of text.

Fields

§text: String

The paragraph text content.

List

A list container (ordered or unordered). Children are ListItem nodes.

Fields

§ordered: bool

Whether this is an ordered list.

ListItem

A single list item.

Fields

§text: String

The list item text content.

Table

A table with structured cell data.

Fields

§grid: TableGrid

The table grid structure.

Image

An image element.

Fields

§description: Option<String>

Alt text or caption.

§src: Option<String>

Image source URL.

§image_index: Option<u32>

Index into ConversionResult.images when image extraction is enabled.

Code

A code block or inline code.

Fields

§text: String

The code text content.

§language: Option<String>

Programming language (from class=“language-*” or similar).

Quote

A block quote container.

DefinitionList

A definition list container.

DefinitionItem

A definition list entry with term and description.

Fields

§term: String

The term being defined.

§definition: String

The definition text.

RawBlock

A raw block preserved as-is (e.g. <script>, <style> content).

Fields

§format: String

The format of the raw content (e.g. “html”, “css”, “javascript”).

§content: String

The raw content.

MetadataBlock

A block of key-value metadata pairs (from <head> meta tags).

Fields

§entries: Vec<(String, String)>

Key-value metadata pairs.

Group

A section grouping container (auto-generated from heading hierarchy).

Fields

§label: Option<String>

Optional section label.

§heading_level: Option<u8>

The heading level that created this group.

§heading_text: Option<String>

The heading text that created this group.

Trait Implementations§

impl Clone for NodeContent

fn clone(&self) -> NodeContent

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for NodeContent

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

Formats the value using the given formatter. Read more

impl Default for NodeContent

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for NodeContent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for NodeContent

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · 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.

impl Serialize for NodeContent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for NodeContent

impl StructuralPartialEq for NodeContent

Auto Trait Implementations§

impl Freeze for NodeContent

impl RefUnwindSafe for NodeContent

impl Send for NodeContent

impl Sync for NodeContent

impl Unpin for NodeContent

impl UnsafeUnpin for NodeContent

impl UnwindSafe for NodeContent

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,