Skip to main content

CompiledExtraction

Struct CompiledExtraction 

Source
pub struct CompiledExtraction { /* private fields */ }
Expand description

A pre-compiled extraction that can be reused across multiple source inputs.

Stores compiled tree_sitter::Query objects and their capture names so they don’t need to be recompiled for every call. A QueryCursor is reused across patterns within a single extraction call, making this type Send + Sync.

Implementations§

Source§

impl CompiledExtraction

Source

pub fn compile(config: &ExtractionConfig) -> Result<Self, Error>

Compile an extraction config for repeated use.

§Errors

Returns an error if the language is not found or any query pattern is invalid.

Source

pub fn compile_with_language( language: Language, language_name: &str, extraction_patterns: &AHashMap<String, ExtractionPattern>, ) -> Result<Self, Error>

Compile extraction patterns using a pre-loaded tree_sitter::Language.

This avoids a redundant language registry lookup when the caller already has the language (e.g., from an earlier parse step).

§Errors

Returns an error if any query pattern is invalid.

Source

pub fn extract(&self, source: &str) -> Result<ExtractionResult, Error>

Extract from source code, parsing it first.

Uses the thread-local parser cache to avoid creating a new parser on every call.

§Errors

Returns an error if parsing fails.

Source

pub fn extract_from_tree( &self, tree: &Tree, source: &[u8], ) -> Result<ExtractionResult, Error>

Extract from an already-parsed tree.

§Errors

Returns an error if query execution fails.

Trait Implementations§

Source§

impl Debug for CompiledExtraction

Source§

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

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

impl Send for CompiledExtraction

Source§

impl Sync for CompiledExtraction

Auto Trait Implementations§

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, 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> 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.