Struct Document 

pub struct Document {
    pub id: DocumentId,
    pub path: Option<PathBuf>,
    pub blocks: Vec<Block>,
    pub block_count: u32,
    pub zone_maps: ZoneMaps,
    /* private fields */
}

A parsed Markdown document stored in the database.

Fields

id: DocumentId

path: Option<PathBuf>

Source file path, if the document was loaded from disk.

blocks: Vec<Block>

Flattened, interval-indexed block list.

block_count: u32

Authoritative block count — valid even when blocks is empty (lazy mode).

zone_maps: ZoneMaps

Per-document statistics for query pruning.

Implementations

impl Document

pub fn new(id: DocumentId, path: Option<PathBuf>, blocks: Vec<Block>) -> Self

pub fn from_parts( id: DocumentId, path: Option<PathBuf>, blocks: Vec<Block>, zone_maps: ZoneMaps, ) -> Self

pub fn from_catalog( id: DocumentId, path: Option<PathBuf>, block_count: u32, zone_maps: ZoneMaps, ) -> Self

Construct from catalog metadata only; blocks will be empty.

pub fn next_sibling<'a>(&'a self, block: &Block) -> Option<&'a Block>

Returns the block immediately following block in document order after its entire section (i.e. the next sibling section), or None.

Uses the interval index: the next sibling has pre == block.post + 1.

pub fn first_child<'a>(&'a self, block: &Block) -> Option<&'a Block>

Returns the first content block INSIDE block’s section, or None.

Uses the interval index: the first child has pre == block.pre + 1. For leaf blocks (no children), this returns None.

pub fn descendants_of<'a>( &'a self, ancestor: &Block, ) -> impl Iterator<Item = &'a Block>

Returns all blocks that are direct or indirect descendants of ancestor in the section hierarchy.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Document