Skip to main content

ParsedDocument

Struct ParsedDocument 

Source
pub struct ParsedDocument<D>
where D: Doc,
{ pub ast_root: Root<D>, pub file_path: PathBuf, pub language: SupportLang, pub content_fingerprint: Fingerprint, pub metadata: DocumentMetadata, /* private fields */ }
Expand description

A parsed document that wraps ast-grep Root with additional codebase-level metadata.

This type preserves all ast-grep functionality while adding context needed for cross-file analysis and graph intelligence. It acts as the bridge between file-level AST operations and codebase-level relational analysis.

Fields§

§ast_root: Root<D>

The underlying ast-grep Root - preserves all ast-grep functionality

§file_path: PathBuf

Source file path for this document

§language: SupportLang

Language of this document

§content_fingerprint: Fingerprint

Content fingerprint for deduplication and change detection (blake3 hash)

§metadata: DocumentMetadata

Codebase-level metadata (symbols, imports, exports, etc.)

Implementations§

Source§

impl<D> ParsedDocument<D>
where D: Doc,

Source

pub fn new( ast_root: Root<D>, file_path: PathBuf, language: SupportLang, content_fingerprint: Fingerprint, ) -> ParsedDocument<D>

Create a new ParsedDocument wrapping an ast-grep Root

Source

pub fn root(&self) -> Node<'_, D>

Get the root node - preserves ast-grep API

Source

pub fn ast_grep_root(&self) -> &Root<D>

Get the underlying ast-grep Root for full access to capabilities

Source

pub fn ast_grep_root_mut(&mut self) -> &mut Root<D>

Get mutable access to ast-grep Root for replacements

Source

pub fn pin_for_threading(&self) -> PinnedNodeData<D, Node<'static, D>>

Create a pinned version for cross-thread/FFI usage

Source

pub fn generate(&self) -> String

Generate the source code (preserves ast-grep replacement functionality)

Source

pub fn metadata(&self) -> &DocumentMetadata

Get document metadata for codebase-level analysis

Source

pub fn metadata_mut(&mut self) -> &mut DocumentMetadata

Get mutable document metadata

Trait Implementations§

Source§

impl<D> Debug for ParsedDocument<D>
where D: Debug + Doc,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<D> !RefUnwindSafe for ParsedDocument<D>

§

impl<D> !UnwindSafe for ParsedDocument<D>

§

impl<D> Freeze for ParsedDocument<D>
where D: Freeze,

§

impl<D> Send for ParsedDocument<D>

§

impl<D> Sync for ParsedDocument<D>

§

impl<D> Unpin for ParsedDocument<D>
where D: Unpin,

§

impl<D> UnsafeUnpin for ParsedDocument<D>
where D: UnsafeUnpin,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more