Struct tree_sitter_graph::ast::File

pub struct File {
    pub language: Language,
    pub globals: Vec<Global>,
    pub inherited_variables: HashSet<Identifier>,
    pub query: Option<Query>,
    pub stanzas: Vec<Stanza>,
    pub shorthands: AttributeShorthands,
}

A graph DSL file

Fields

language: Language

globals: Vec<Global>

The expected global variables used in this file

inherited_variables: HashSet<Identifier>

The scoped variables that are inherited by child nodes

query: Option<Query>

The combined query of all stanzas in the file

stanzas: Vec<Stanza>

The list of stanzas in the file

shorthands: AttributeShorthands

Attribute shorthands defined in the file

Implementations

impl File

pub fn new(language: Language) -> File

impl File

pub fn check(&mut self) -> Result<(), CheckError>

impl File

pub fn execute<'a, 'tree>( &self, tree: &'tree Tree, source: &'tree str, config: &ExecutionConfig<'_, '_>, cancellation_flag: &dyn CancellationFlag ) -> Result<Graph<'tree>, ExecutionError>

Executes this graph DSL file against a source file. You must provide the parsed syntax tree (tree) as well as the source text that it was parsed from (source). You also provide the set of functions and global variables that are available during execution.

pub fn execute_into<'a, 'tree>( &self, graph: &mut Graph<'tree>, tree: &'tree Tree, source: &'tree str, config: &ExecutionConfig<'_, '_>, cancellation_flag: &dyn CancellationFlag ) -> Result<(), ExecutionError>

Executes this graph DSL file against a source file, saving the results into an existing Graph instance. You must provide the parsed syntax tree (tree) as well as the source text that it was parsed from (source). You also provide the set of functions and global variables that are available during execution. This variant is useful when you need to “pre-seed” the graph with some predefined nodes and/or edges before executing the DSL file.

pub fn try_visit_matches<'tree, E, F>( &self, tree: &'tree Tree, source: &'tree str, lazy: bool, visit: F ) -> Result<(), E>

where F: FnMut(Match<'_, 'tree>) -> Result<(), E>,

impl File

pub fn from_str(language: Language, source: &str) -> Result<Self, ParseError>

Parses a graph DSL file, returning a new File instance.

pub fn parse(&mut self, content: &str) -> Result<(), ParseError>

👎Deprecated: Parsing multiple times into the same File instance is unsound. Use File::from_str instead.

Parses a graph DSL file, adding its content to an existing File instance.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.