Skip to main content

StrDoc

Struct StrDoc 

Source
pub struct StrDoc<L: LanguageExt> {
    pub src: String,
    pub lang: L,
    pub tree: Tree,
}
Expand description

Document type that combines source code with its parsed tree-sitter AST.

StrDoc represents a complete parsed document, holding both the original source code and the tree-sitter AST. It supports incremental parsing, meaning when edits are made to the source, only the affected parts of the tree are re-parsed for better performance.

§Type Parameters

  • L: LanguageExt - The language implementation that provides tree-sitter integration

§Example

let doc = StrDoc::new("const x = 42;", JavaScript);
let root = doc.root_node();
println!("AST root: {}", root.kind());

Fields§

§src: String

The source code text

§lang: L

Language implementation for parsing and node operations

§tree: Tree

The parsed tree-sitter AST

Implementations§

Source§

impl<L: LanguageExt> StrDoc<L>

Source

pub fn try_new(src: &str, lang: L) -> Result<Self, String>

Source

pub fn new(src: &str, lang: L) -> Self

Trait Implementations§

Source§

impl<L: Clone + LanguageExt> Clone for StrDoc<L>

Source§

fn clone(&self) -> StrDoc<L>

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
Source§

impl<L: Debug + LanguageExt> Debug for StrDoc<L>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<L: LanguageExt> Doc for StrDoc<L>

Source§

type Source = String

The source code representation (String, UTF-16, etc.)
Source§

type Lang = L

The programming language implementation
Source§

type Node<'r> = Node<'r>

The AST node type for this document
Source§

fn get_lang(&self) -> &Self::Lang

Get the language implementation for this document
Source§

fn get_source(&self) -> &Self::Source

Get the source code content
Source§

fn do_edit(&mut self, edit: &Edit<Self::Source>) -> Result<(), String>

Apply an edit to the document, updating both source and AST
Source§

fn root_node(&self) -> Node<'_>

Get the root AST node
Source§

fn get_node_text<'a>(&'a self, node: &Self::Node<'a>) -> Cow<'a, str>

Extract the text content of a specific AST node
Source§

impl<'t, L: LanguageExt> Traversal<'t, StrDoc<L>> for Post<'t, L>

Source§

fn calibrate_for_match(&mut self, depth: Option<usize>)

Adjust cursor position to implement non-reentrant matching behavior. Read more
Source§

fn get_current_depth(&self) -> usize

Get the current depth in the tree traversal. Read more
Source§

impl<'t, L: LanguageExt> Traversal<'t, StrDoc<L>> for Pre<'t, L>

Source§

fn calibrate_for_match(&mut self, depth: Option<usize>)

Adjust cursor position to implement non-reentrant matching behavior. Read more
Source§

fn get_current_depth(&self) -> usize

Get the current depth in the tree traversal. Read more

Auto Trait Implementations§

§

impl<L> Freeze for StrDoc<L>
where L: Freeze,

§

impl<L> RefUnwindSafe for StrDoc<L>
where L: RefUnwindSafe,

§

impl<L> Send for StrDoc<L>

§

impl<L> Sync for StrDoc<L>

§

impl<L> Unpin for StrDoc<L>
where L: Unpin,

§

impl<L> UnsafeUnpin for StrDoc<L>
where L: UnsafeUnpin,

§

impl<L> UnwindSafe for StrDoc<L>
where L: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.