Struct MastNodeId 

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

An opaque handle to a MastNode in some MastForest. It is the responsibility of the user to use a given MastNodeId with the corresponding MastForest.

Note that the MastForest does not ensure that equal MastNodes have equal MastNodeId handles. Hence, MastNodeId equality must not be used to test for equality of the underlying MastNode.

Implementations

impl MastNodeId

pub fn from_u32_safe( value: u32, mast_forest: &MastForest, ) -> Result<Self, DeserializationError>

Returns a new MastNodeId with the provided inner value, or an error if the provided value is greater than the number of nodes in the forest.

For use in deserialization.

pub fn from_usize_safe( node_id: usize, mast_forest: &MastForest, ) -> Result<Self, DeserializationError>

Returns a new MastNodeId with the provided node_id, or an error if node_id is greater than the number of nodes in the MastForest for which this ID is being constructed.

pub fn new_unchecked(value: u32) -> Self

Returns a new MastNodeId from the given value without checking its validity.

pub fn remap(&self, remapping: &Remapping) -> Self

Remap the NodeId to its new position using the given Remapping.

Trait Implementations

impl Arbitrary for MastNodeId

Available on crate features arbitrary only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<MastNodeId>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MastNodeId

fn clone(&self) -> MastNodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MastNodeId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MastNodeId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MastNodeId

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

Formats the value using the given formatter.

impl From<MastNodeId> for u32

fn from(value: MastNodeId) -> Self

Converts to this type from the input type.

impl From<u32> for MastNodeId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for MastNodeId

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 Idx for MastNodeId

fn to_usize(self) -> usize

Convert from this ID type to usize.

impl Index<MastNodeId> for MastForest

type Output = MastNode

The returned type after indexing.

fn index(&self, node_id: MastNodeId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<MastNodeId> for MastForest

fn index_mut(&mut self, node_id: MastNodeId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for MastNodeId

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MastNodeId

impl Eq for MastNodeId

impl StructuralPartialEq for MastNodeId