Struct Chunk 

#[non_exhaustive]
pub struct Chunk {
    pub heading_path: Vec<String>,
    pub markdown: String,
}

Available on crate feature markdown only.

A piece of a document’s Markdown, small enough for an embedding model or a prompt, with the headings it sits under — so every chunk stands on its own. Built by Dom::to_markdown_chunks.

With the serde feature, Chunk implements serde::Serialize ({"heading_path": [...], "markdown": "..."}).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

heading_path: Vec<String>

The plain-text titles of the headings this chunk sits under, outermost first (["Guide", "Install"]). Empty before the first heading. A title longer than 256 characters is cut to its first 256, followed by … (the heading line itself stays whole in Chunk::markdown).

markdown: String

The chunk’s Markdown. It starts with its section’s heading line when it is the first chunk of that section.

Implementations

impl Chunk

pub fn context(&self) -> String

The heading path as one line of context, joined with " > " — e.g. "Guide > Install" — to prepend to the chunk when embedding it. Empty when the chunk comes before any heading.

let dom = domq::parse("<h1>Guide</h1><h2>Install</h2><p>Run it.</p>");
let chunks = dom.to_markdown_chunks(1000);
assert_eq!(chunks[0].context(), "Guide > Install");

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Default for Chunk

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Chunk

impl PartialEq for Chunk

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Chunk

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Chunk