Skip to main content

ProcessConfig

Struct ProcessConfig 

Source
pub struct ProcessConfig {
    pub language: Cow<'static, str>,
    pub structure: bool,
    pub imports: bool,
    pub exports: bool,
    pub comments: bool,
    pub docstrings: bool,
    pub symbols: bool,
    pub diagnostics: bool,
    pub chunk_max_size: Option<usize>,
    pub extractions: Option<AHashMap<String, ExtractionPattern>>,
}
Expand description

Configuration for the process() function.

Controls which analysis features are enabled and whether chunking is performed.

§Examples

use tree_sitter_language_pack::ProcessConfig;

// Defaults: structure + imports + exports enabled
let config = ProcessConfig::new("python");

// With chunking
let config = ProcessConfig::new("python").with_chunking(1000);

// Everything enabled
let config = ProcessConfig::new("python").all();

Fields§

§language: Cow<'static, str>

Language name (required).

§structure: bool

Extract structural items (functions, classes, etc.). Default: true.

§imports: bool

Extract import statements. Default: true.

§exports: bool

Extract export statements. Default: true.

§comments: bool

Extract comments. Default: false.

§docstrings: bool

Extract docstrings. Default: false.

§symbols: bool

Extract symbol definitions. Default: false.

§diagnostics: bool

Include parse diagnostics. Default: false.

§chunk_max_size: Option<usize>

Maximum chunk size in bytes. None disables chunking.

§extractions: Option<AHashMap<String, ExtractionPattern>>

Custom extraction patterns to run against the parsed tree. Keys become the keys in ProcessResult::extractions.

Implementations§

Source§

impl ProcessConfig

Source

pub fn new(language: impl Into<String>) -> Self

Create a new config for the given language with default settings.

Source

pub fn with_chunking(self, max_size: usize) -> Self

Enable chunking with the given maximum chunk size in bytes.

Source

pub fn all(self) -> Self

Enable all analysis features.

Source

pub fn minimal(self) -> Self

Disable all analysis features (only metrics computed).

Trait Implementations§

Source§

impl Clone for ProcessConfig

Source§

fn clone(&self) -> ProcessConfig

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 Debug for ProcessConfig

Source§

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

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

impl Default for ProcessConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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

Source§

type Output = T

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