Struct DocChunk 

pub struct DocChunk {
    pub text: String,
    pub start: usize,
    pub end: usize,
    pub heading_path: Vec<String>,
}

A provenance-preserving slice of a document produced by chunk.

Like DocBlock, the byte offsets index into the originating document’s source text, so a chunk can always be traced back to its origin.

Fields

text: String

The chunk’s text, copied from the source span.

start: usize

Inclusive start byte offset of the chunk within the source text.

end: usize

Exclusive end byte offset of the chunk within the source text.

heading_path: Vec<String>

The heading path in effect for the source span, outermost first.

Implementations

impl DocChunk

pub fn as_expr(&self) -> Expr

Project this chunk into its Expr map form (kind: doc-chunk, with text, start, end, and heading_path).

Trait Implementations

impl Clone for DocChunk

fn clone(&self) -> DocChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocChunk

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

Formats the value using the given formatter.

impl Eq for DocChunk

impl PartialEq for DocChunk

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

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

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 StructuralPartialEq for DocChunk