Struct tree_sitter_graph::graph::Graph

pub struct Graph<'tree> { /* private fields */ }

A graph produced by executing a graph DSL file. Graphs include a lifetime parameter to ensure that they don’t outlive the tree-sitter syntax tree that they are generated from.

Implementations

impl<'tree> Graph<'tree>

pub fn new() -> Graph<'tree>

Creates a new, empty graph.

pub fn add_syntax_node(&mut self, node: Node<'tree>) -> SyntaxNodeRef

Adds a syntax node to the graph, returning a graph DSL reference to it.

The graph won’t contain every syntax node in the parsed syntax tree; it will only contain those nodes that are referenced at some point during the execution of the graph DSL file.

pub fn add_graph_node(&mut self) -> GraphNodeRef

Adds a new graph node to the graph, returning a graph DSL reference to it.

pub fn pretty_print<'a>(&'a self) -> impl Display + 'a

Pretty-prints the contents of this graph.

pub fn display_json(&self, path: Option<&Path>) -> Result<()>

pub fn iter_nodes(&self) -> impl Iterator<Item = GraphNodeRef>

pub fn node_count(&self) -> usize

Trait Implementations

impl<'tree> Default for Graph<'tree>

fn default() -> Graph<'tree>

Returns the “default value” for a type.

impl Index<GraphNodeRef> for Graph<'_>

type Output = GraphNode

The returned type after indexing.

fn index(&self, index: GraphNodeRef) -> &GraphNode

Performs the indexing (container[index]) operation.

impl<'tree> Index<SyntaxNodeRef> for Graph<'tree>

type Output = Node<'tree>

The returned type after indexing.

fn index(&self, node_ref: SyntaxNodeRef) -> &Node<'tree>

Performs the indexing (container[index]) operation.

impl<'tree> IndexMut<GraphNodeRef> for Graph<'_>

fn index_mut(&mut self, index: GraphNodeRef) -> &mut GraphNode

Performs the mutable indexing (container[index]) operation.

impl<'tree> Serialize for Graph<'tree>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.