Struct bigraph::NodeIndex

pub struct NodeIndex<IndexType>(_);

Trait Implementations

impl<IndexType> Add<usize> for NodeIndex<IndexType> where
    IndexType: PrimInt, 

type Output = NodeIndex<IndexType>

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> <NodeIndex<IndexType> as Add<usize>>::Output

Performs the + operation.

impl<IndexType> Clone for NodeIndex<IndexType> where
    IndexType: Clone, 

fn clone(&self) -> NodeIndex<IndexType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<IndexType> Copy for NodeIndex<IndexType> where
    IndexType: Copy, 

impl<IndexType> Debug for NodeIndex<IndexType> where
    IndexType: PrimInt, 

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

Formats the value using the given formatter.

impl<IndexType> Eq for NodeIndex<IndexType> where
    IndexType: Eq, 

impl<IndexType> From<NodeIndex<IndexType>> for OptionalNodeIndex<IndexType> where
    IndexType: PrimInt, 

fn from(source: NodeIndex<IndexType>) -> OptionalNodeIndex<IndexType>

Performs the conversion.

impl<IndexType> From<NodeIndex<IndexType>> for NodeIndex<IndexType> where
    IndexType: ToPrimitive + PrimInt + IndexType, 

fn from(index: NodeIndex<IndexType>) -> NodeIndex<IndexType>

Performs the conversion.

impl<IndexType> From<usize> for NodeIndex<IndexType> where
    IndexType: PrimInt, 

fn from(source: usize) -> NodeIndex<IndexType>

Performs the conversion.

impl<IndexType> GraphIndex<OptionalNodeIndex<IndexType>> for NodeIndex<IndexType> where
    IndexType: PrimInt, 

fn as_usize(self) -> usize

Get this index as usize.

impl<IndexType> Hash for NodeIndex<IndexType> where
    IndexType: Hash, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<IndexType> OptionalGraphIndex<NodeIndex<IndexType>> for OptionalNodeIndex<IndexType> where
    IndexType: PrimInt, 

fn as_usize(self) -> Option<usize>

Get this index as usize, but return None if this index is marked as invalid.

fn as_usize_unchecked(self) -> usize

A faster method to get the usize value of the index, which does not perform any validity checks.

fn is_valid(self) -> bool

Returns true if the index is valid, i.e. if it is not marked as invalid.

fn new_none() -> Self

Returns a new OptionalGraphIndex that is marked as invalid.

impl<IndexType> Ord for NodeIndex<IndexType> where
    IndexType: Ord, 

fn cmp(&self, other: &NodeIndex<IndexType>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<IndexType> PartialEq<NodeIndex<IndexType>> for NodeIndex<IndexType> where
    IndexType: PartialEq<IndexType>, 

fn eq(&self, other: &NodeIndex<IndexType>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NodeIndex<IndexType>) -> bool

This method tests for !=.

impl<IndexType> PartialOrd<NodeIndex<IndexType>> for NodeIndex<IndexType> where
    IndexType: PartialOrd<IndexType>, 

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

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

fn lt(&self, other: &NodeIndex<IndexType>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &NodeIndex<IndexType>) -> bool

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

fn gt(&self, other: &NodeIndex<IndexType>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &NodeIndex<IndexType>) -> bool

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