Struct stack_graphs::graph::StackGraph

pub struct StackGraph { /* fields omitted */ }

Contains all of the nodes and edges that make up a stack graph.

Implementations

impl StackGraph

pub fn add_symbol<S: AsRef<str> + ?Sized>(
    &mut self,
    symbol: &S
) -> Handle<Symbol>

Adds a symbol to the stack graph, ensuring that there’s only ever one copy of a particular symbol stored in the graph.

pub fn iter_symbols(&self) -> impl Iterator<Item = Handle<Symbol>>

Returns an iterator over all of the handles of all of the symbols in this stack graph. (Note that because we’re only returning handles, this iterator does not retain a reference to the StackGraph.)

impl StackGraph

pub fn add_file<S: AsRef<str> + ?Sized>(
    &mut self,
    name: &S
) -> Result<Handle<File>, Handle<File>>

Adds a file to the stack graph. There can only ever be one file with a particular name in the graph. If a file with the requested name already exists, we return Err; if it doesn’t already exist, we return Ok. In both cases, the value of the result is the file’s handle.

pub fn get_or_create_file<S: AsRef<str> + ?Sized>(
    &mut self,
    name: &S
) -> Handle<File>

Adds a file to the stack graph, returning its handle. There can only ever be one file with a particular name in the graph, so if you call this multiple times with the same name, you’ll get the same handle each time.

impl StackGraph

pub fn iter_files(&self) -> impl Iterator<Item = Handle<File>> + '_

Returns an iterator over all of the handles of all of the files in this stack graph. (Note that because we’re only returning handles, this iterator does not retain a reference to the StackGraph.)

impl StackGraph

pub fn jump_to_node(&self) -> Handle<Node>

Returns a handle to the stack graph’s singleton jump to scope node.

pub fn root_node(&self) -> Handle<Node>

Returns a handle to the stack graph’s singleton root node.

pub fn new_node_id(&mut self, file: Handle<File>) -> NodeID

Returns an unused local node ID for the given file.

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

Returns an iterator of all of the nodes in the graph. (Note that because we’re only returning handles, this iterator does not retain a reference to the StackGraph.)

pub fn node_for_id(&self, node_id: NodeID) -> Option<Handle<Node>>

Returns the handle to the node with a particular ID, if it exists.

impl StackGraph

pub fn resolve_unknown_node(&mut self, node: Node) -> Result<(), &Node>

Resolves an unknown node with a “real” node. Panics if there isn’t a node in the arena with the same ID as node. Returns an error is that node is not an unknown node.

impl StackGraph

pub fn add_edge(&mut self, edge: Edge)

Adds a new edge to the stack graph.

pub fn remove_edge(&mut self, edge: Edge)

Removes an edge from the stack graph.

pub fn outgoing_edges(
    &self,
    source: Handle<Node>
) -> impl Iterator<Item = Edge> + '_

Returns an iterator of all of the edges that begin at a particular source node.

impl StackGraph

pub fn new() -> StackGraph

Creates a new, initially empty stack graph.

Trait Implementations

impl Index<Handle<File>> for StackGraph

type Output = File

The returned type after indexing.

fn index(&self, handle: Handle<File>) -> &File

Performs the indexing (container[index]) operation.

impl Index<Handle<Node>> for StackGraph

type Output = Node

The returned type after indexing.

fn index(&self, handle: Handle<Node>) -> &Node

Performs the indexing (container[index]) operation.

impl Index<Handle<Symbol>> for StackGraph

type Output = Symbol

The returned type after indexing.

fn index(&self, handle: Handle<Symbol>) -> &Symbol

Performs the indexing (container[index]) operation.

impl IndexMut<Handle<Node>> for StackGraph

fn index_mut(&mut self, handle: Handle<Node>) -> &mut Node

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