Struct NodeKey 

pub struct NodeKey { /* private fields */ }

A node identity that survives recompilation and renumbering.

Ordered and hashable so it can key a lookup table; the ordering is an implementation detail of the provenance encoding and carries no meaning. Display renders it the way the .bloqir text format spells provenance, suffixed with #ordinal.

Implementations

impl NodeKey

pub fn ordinal(&self) -> u32

This node’s index among the nodes of its level that share its provenance, in SubGraph::deterministic_emit_order.

Always 0 on a key from BloqNode::stable_key, which sees one node and so cannot count its peers; SubGraph::stable_keys assigns the real ordinals.

Trait Implementations

impl Clone for NodeKey

fn clone(&self) -> NodeKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeKey

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

Formats the value using the given formatter.

impl Display for NodeKey

Mirrors NodeProvenance’s Display, so a key and the program view name the same node alike.

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

Formats the value using the given formatter.

impl Eq for NodeKey

impl Hash for NodeKey

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 Ord for NodeKey

fn cmp(&self, other: &NodeKey) -> 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 NodeKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NodeKey

fn partial_cmp(&self, other: &NodeKey) -> 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 StructuralPartialEq for NodeKey