Struct NodeID

#[repr(C)]
pub struct NodeID { /* private fields */ }

Uniquely identifies a node in a stack graph.

Each node (except for the root node and jump to scope node) lives in a file, and has a local ID that must be unique within its file.

Implementations

impl NodeID

pub fn root() -> NodeID

Returns the ID of the singleton root node.

pub fn jump_to() -> NodeID

Returns the ID of the singleton jump to scope node.

pub fn new_in_file(file: Handle<File>, local_id: u32) -> NodeID

Creates a new file-local node ID.

pub fn is_root(self) -> bool

Returns whether this ID refers to the singleton root node.

pub fn is_jump_to(self) -> bool

Returns whether this ID refers to the singleton jump to scope 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 local_id(self) -> u32

Returns the local ID of this node within its file. Panics if this node ID refers to the singleton root or jump to scope nodes.

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.

impl NodeID

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

Trait Implementations

impl Clone for NodeID

fn clone(&self) -> NodeID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeID

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

Formats the value using the given formatter.

impl Default for NodeID

fn default() -> NodeID

Returns the “default value” for a type.

impl Hash for NodeID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<NodeID> for sg_node_id

fn into(self) -> NodeID

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

impl Ord for NodeID

fn cmp(&self, other: &NodeID) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for NodeID

fn eq(&self, other: &NodeID) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for NodeID

fn partial_cmp(&self, other: &NodeID) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for NodeID

impl Eq for NodeID

impl StructuralPartialEq for NodeID