Enum stack_graphs::graph::Node

#[repr(C)]
pub enum Node {
    DropScopes(DropScopesNode),
    JumpTo(JumpToNode),
    PopScopedSymbol(PopScopedSymbolNode),
    PopSymbol(PopSymbolNode),
    PushScopedSymbol(PushScopedSymbolNode),
    PushSymbol(PushSymbolNode),
    Root(RootNode),
    Scope(ScopeNode),
}

A node in a stack graph.

Variants

DropScopes(DropScopesNode)

JumpTo(JumpToNode)

PopScopedSymbol(PopScopedSymbolNode)

PopSymbol(PopSymbolNode)

PushScopedSymbol(PushScopedSymbolNode)

PushSymbol(PushSymbolNode)

Root(RootNode)

Scope(ScopeNode)

Implementations

impl Node

pub fn is_exported_scope(&self) -> bool

pub fn is_definition(&self) -> bool

pub fn is_reference(&self) -> bool

pub fn is_jump_to(&self) -> bool

pub fn is_root(&self) -> bool

pub fn is_endpoint(&self) -> bool

pub fn symbol(&self) -> Option<Handle<Symbol>>

Returns this node’s symbol, if it has one. (Pop symbol, pop scoped symbol, push symbol, and push scoped symbol nodes have symbols.)

pub fn scope(&self) -> Option<NodeID>

Returns this node’s attached scope, if it has one. (Push scoped symbol nodes have attached scopes.)

pub fn id(&self) -> NodeID

Returns the ID of this node.

pub fn file(&self) -> Option<Handle<File>>

Returns the file that this node belongs to. Returns None for the singleton root and jump to scope nodes, which belong to all files.

pub fn is_in_file(&self, file: Handle<File>) -> bool

Returns whether this node belongs to a particular file. Always returns true for the singleton root and jump to scope nodes, which belong to all files.

pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl Display + 'a

Trait Implementations

impl From<DropScopesNode> for Node

fn from(node: DropScopesNode) -> Node

Converts to this type from the input type.

impl From<JumpToNode> for Node

fn from(node: JumpToNode) -> Node

Converts to this type from the input type.

impl From<PopScopedSymbolNode> for Node

fn from(node: PopScopedSymbolNode) -> Node

Converts to this type from the input type.

impl From<PopSymbolNode> for Node

fn from(node: PopSymbolNode) -> Node

Converts to this type from the input type.

impl From<PushScopedSymbolNode> for Node

fn from(node: PushScopedSymbolNode) -> Node

Converts to this type from the input type.

impl From<PushSymbolNode> for Node

fn from(node: PushSymbolNode) -> Node

Converts to this type from the input type.

impl From<RootNode> for Node

fn from(node: RootNode) -> Node

Converts to this type from the input type.

impl From<ScopeNode> for Node

fn from(node: ScopeNode) -> Node

Converts to this type from the input type.

impl Into<Node> for sg_node

fn into(self) -> Node

Converts this type into the (usually inferred) input type.