Struct traitgraph::index::OptionalNodeIndex

pub struct OptionalNodeIndex<IndexType: Sized>(_);

A node index that can be None. This is a hack to get a small sized Option<NodeIndex> by storing the None variant as IndexType::max_value(). If Rust ever adds support for integer types with invalid values other than 0, this type becomes obsolete.

Trait Implementations

impl<IndexType: PrimInt + Hash> Add<usize> for OptionalNodeIndex<IndexType>

type Output = OptionalNodeIndex<IndexType>

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl<IndexType: Clone + Sized> Clone for OptionalNodeIndex<IndexType>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<IndexType: PrimInt + Hash> Debug for OptionalNodeIndex<IndexType>

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

Formats the value using the given formatter.

impl<IndexType: PrimInt> Default for OptionalNodeIndex<IndexType>

fn default() -> Self

Returns the “default value” for a type.

impl<IndexType: PrimInt + Hash> From<NodeIndex<IndexType>> for OptionalNodeIndex<IndexType>

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

Converts to this type from the input type.

impl<IndexType: PrimInt + Hash> From<Option<NodeIndex<IndexType>>> for OptionalNodeIndex<IndexType>

fn from(source: Option<NodeIndex<IndexType>>) -> Self

Converts to this type from the input type.

impl<IndexType: PrimInt> From<Option<usize>> for OptionalNodeIndex<IndexType>

fn from(source: Option<usize>) -> Self

Converts to this type from the input type.

impl<IndexType: PrimInt + Hash> From<OptionalNodeIndex<IndexType>> for Option<NodeIndex<IndexType>>

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

Converts to this type from the input type.

impl<IndexType: PrimInt> From<usize> for OptionalNodeIndex<IndexType>

fn from(source: usize) -> Self

Converts to this type from the input type.

impl<IndexType: PrimInt + Hash> GraphIndex<OptionalNodeIndex<IndexType>> for NodeIndex<IndexType>

fn as_usize(self) -> usize

Get this index as usize.

impl<IndexType: Hash + Sized> Hash for OptionalNodeIndex<IndexType>

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, 

Feeds a slice of this type into the given Hasher.

impl<IndexType: PrimInt + Hash> OptionalGraphIndex<NodeIndex<IndexType>> for OptionalNodeIndex<IndexType>

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 is_none(self) -> bool

Returns true if the index is None.

fn is_some(self) -> bool

Returns true if the index is Some.

fn new_none() -> Self

Returns a new OptionalGraphIndex that is marked as invalid.

fn unwrap(self) -> MirrorGraphIndex

Returns the graph index stored in this optional graph index. Panics if this optional graph index is None.

impl<IndexType: Ord + Sized> Ord for OptionalNodeIndex<IndexType>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<IndexType: PartialEq + Sized> PartialEq<OptionalNodeIndex<IndexType>> for OptionalNodeIndex<IndexType>

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

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

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

This method tests for !=.

impl<IndexType: PartialOrd + Sized> PartialOrd<OptionalNodeIndex<IndexType>> for OptionalNodeIndex<IndexType>

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

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

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

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

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

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

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

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

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

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

impl<IndexType: PrimInt + Hash> Sub<usize> for OptionalNodeIndex<IndexType>

type Output = OptionalNodeIndex<IndexType>

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl<IndexType: Copy + Sized> Copy for OptionalNodeIndex<IndexType>

impl<IndexType: Eq + Sized> Eq for OptionalNodeIndex<IndexType>

impl<IndexType: Sized> StructuralEq for OptionalNodeIndex<IndexType>

impl<IndexType: Sized> StructuralPartialEq for OptionalNodeIndex<IndexType>