Struct OutlineCodeTreeSitter 

pub struct OutlineCodeTreeSitter { /* private fields */ }

Available on crate feature tree-sitter only.

OutlineCodeTreeSitter adds a “Outline” field to the metadata of a node that contains a summary of the code in the node. It uses the tree-sitter parser to parse the code and remove any information that is less relevant for tasks that consider the file as a whole.

Implementations

impl OutlineCodeTreeSitter

pub fn builder() -> OutlineCodeTreeSitterBuilder

Creates a new builder for the transformer

pub fn from_client( client: impl SimplePrompt + 'static, ) -> OutlineCodeTreeSitterBuilder

Build a new transformer from a client

pub fn new(client: impl SimplePrompt + 'static) -> Self

Create a new transformer from a client

pub fn with_concurrency(self, concurrency: usize) -> Self

Set the concurrency level for the transformer

impl OutlineCodeTreeSitter

pub fn try_for_language( lang: impl TryInto<SupportedLanguages>, minimum_file_size: Option<usize>, ) -> Result<Self>

Tries to create a OutlineCodeTreeSitter instance for a given programming language.

Parameters

• lang: The programming language to be used to parse the code. It should implement TryInto<SupportedLanguages>.

Returns

• Result<Self>: Returns an instance of OutlineCodeTreeSitter if successful, otherwise returns an error.

Errors

• Returns an error if the language is not supported or if the CodeOutliner fails to build.

Trait Implementations

impl Clone for OutlineCodeTreeSitter

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OutlineCodeTreeSitter

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

Formats the value using the given formatter.

impl Transformer for OutlineCodeTreeSitter

fn transform_node<'life0, 'async_trait>( &'life0 self, node: TextNode, ) -> Pin<Box<dyn Future<Output = Result<TextNode>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Adds context to the metadata of a TextNode containing code in the “Outline” field.

It uses the CodeOutliner to generate the context.

Parameters

• node: The TextNode containing the code of which the context is to be generated.

Returns

• TextNode: The same TextNode instances, with the metadata updated to include the generated context.

Errors

• If the code outlining fails, an error is sent downstream.

type Input = String

type Output = String

fn concurrency(&self) -> Option<usize>

Overrides the default concurrency of the pipeline

fn name(&self) -> &'static str

impl WithIndexingDefaults for OutlineCodeTreeSitter

fn with_indexing_defaults(&mut self, defaults: IndexingDefaults)