Struct NodeId 

pub struct NodeId(/* private fields */);

A unique identifier for a node.

In view callbacks, create NodeIds with the crate::id macro.

Implementations

impl NodeId

pub fn next() -> Self

Create a new NodeId. For times when the id!() macro isn’t appropriate, such as when creating ids in a loop.

Not suitable for use in a view callback since it returns a unique id every time.

pub fn set_counter(value: u64)

Resume NodeId generation from a specific value. This is useful in the exceptionally rare cases when resuming id creation from a particular value with the NodeId::next() function is required.

Panics: if value is zero, as NodeId values must be non-zero.

pub fn get_counter() -> u64

Returns the current value of the NodeId generator. Useful for persisting the id counter to resume later with NodeId::set_counter().

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 Copy for NodeId

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 Eq for NodeId

impl From<NodeId> for u64

fn from(id: NodeId) -> u64

Converts to this type from the input type.

impl From<NodeId> for NodeId

fn from(value: NodeId) -> Self

Converts to this type from the input 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 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 StructuralPartialEq for NodeId