Struct Document

pub struct Document {
    pub texter: Text,
    pub tree: Tree,
}

Represents a text document that combines plain text texter with its parsed syntax tree tree_sitter::Tree.

This struct allows for incremental updates of both the text content and the syntax tree, ensuring they stay synchronized after each change. It provides utility functions for querying the syntax tree, such as finding nodes by position or range.

Fields

texter: Text

tree: Tree

Implementations

impl Document

pub fn new(texter: Text, tree: Tree) -> Self

pub fn update( &mut self, parser: &mut Parser, changes: &[TextDocumentContentChangeEvent], ) -> Result<(), DocumentError>

Updates the document based on the provided list of text changes.

This method applies the changes to both the text texter and the syntax tree Tree. It uses incremental parsing to minimize the cost of updating the syntax tree.

Parameters

• parser: A mutable reference to the Tree-sitter parser used to reparse the document.
• changes: A vector of TextDocumentContentChangeEvent objects representing text changes.

Errors

Returns an error if Tree-sitter fails to reparse the updated text

pub fn node_at_position(&self, position: Position) -> Option<Node<'_>>

Retrieves the smallest syntax node that spans the given position in the document.

pub fn node_range_at(&self, offset: usize) -> Option<Range>

Retrieves the range (start and end positions) of the smallest syntax node that spans the given byte offset.

pub fn position_at(&self, offset: usize) -> Result<Position, PositionError>

Converts a byte offset in the document to its corresponding position (line and character).

pub fn range_at(&self, range: Range<usize>) -> Result<Range, PositionError>

Converts a byte offset in the document to its corresponding range (start and end positions).

pub fn offset_at(&self, position: Position) -> Option<usize>

Converts a position (line and character) in the document to its corresponding byte offset.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy 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.