Struct NodeId

#[repr(transparent)]
pub struct NodeId(pub u32);

Id of a node in a hugr graph.

Tuple Fields

0: u32

Implementations

impl NodeId

pub fn new(index: usize) -> Self

Create a new index.

Panics

Panics if the index is 2^32 or larger.

pub fn is_valid(self) -> bool

Returns whether the index is valid.

pub fn index(self) -> usize

Returns the index as a usize to conveniently use it as a slice index.

pub fn unwrap_slice(slice: &[Self]) -> &[u32]

Convert a slice of this index type into a slice of u32s.

pub fn wrap_slice(slice: &[u32]) -> &[Self]

Convert a slice of u32s into a slice of this index type.

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() -> Self

Returns the “default value” for a type.

impl Display for NodeId

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

Formats the value using the given formatter.

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 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<'a> View<'a, NodeId> for Node

fn view(module: &'a Module<'a>, id: NodeId) -> Option<Self>

Attempt to interpret a subpart of a module as this type.

impl<'a> View<'a, NodeId> for SymbolName

fn view(module: &'a Module<'a>, id: NodeId) -> Option<Self>

Attempt to interpret a subpart of a module as this type.

impl Copy for NodeId

impl Eq for NodeId

impl StructuralPartialEq for NodeId