Struct petgraph::graph::EdgeIndex

pub struct EdgeIndex<Ix = DefaultIx>(/* private fields */);

Edge identifier.

Implementations

impl<Ix: IndexType> EdgeIndex<Ix>

pub fn new(x: usize) -> Self

pub fn index(self) -> usize

pub fn end() -> Self

An invalid EdgeIndex used to denote absence of an edge, for example to end an adjacency list.

Trait Implementations

impl<Ix: Clone> Clone for EdgeIndex<Ix>

fn clone(&self) -> EdgeIndex<Ix>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Debug> Debug for EdgeIndex<Ix>

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

Formats the value using the given formatter.

impl<Ix: Default> Default for EdgeIndex<Ix>

fn default() -> EdgeIndex<Ix>

Returns the “default value” for a type.

impl<Ix: IndexType> From<Ix> for EdgeIndex<Ix>

fn from(ix: Ix) -> Self

Converts to this type from the input type.

impl<Ix: Hash> Hash for EdgeIndex<Ix>

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<N, E, Ty, Ix> Index<EdgeIndex<Ix>> for Graph<N, E, Ty, Ix>

where Ty: EdgeType, Ix: IndexType,

Index the Graph by EdgeIndex to access edge weights.

Panics if the edge doesn’t exist.

type Output = E

The returned type after indexing.

fn index(&self, index: EdgeIndex<Ix>) -> &E

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> Index<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>

where Ty: EdgeType, Ix: IndexType,

Index the StableGraph by EdgeIndex to access edge weights.

Panics if the edge doesn’t exist.

type Output = E

The returned type after indexing.

fn index(&self, index: EdgeIndex<Ix>) -> &E

Performs the indexing (container[index]) operation.

impl<N, E, Ty, Ix> IndexMut<EdgeIndex<Ix>> for Graph<N, E, Ty, Ix>

where Ty: EdgeType, Ix: IndexType,

Index the Graph by EdgeIndex to access edge weights.

Panics if the edge doesn’t exist.

fn index_mut(&mut self, index: EdgeIndex<Ix>) -> &mut E

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

impl<N, E, Ty, Ix> IndexMut<EdgeIndex<Ix>> for StableGraph<N, E, Ty, Ix>

where Ty: EdgeType, Ix: IndexType,

Index the StableGraph by EdgeIndex to access edge weights.

Panics if the edge doesn’t exist.

fn index_mut(&mut self, index: EdgeIndex<Ix>) -> &mut E

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

impl<Ix: Ord> Ord for EdgeIndex<Ix>

fn cmp(&self, other: &EdgeIndex<Ix>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<Ix: PartialEq> PartialEq for EdgeIndex<Ix>

fn eq(&self, other: &EdgeIndex<Ix>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Ix: PartialOrd> PartialOrd for EdgeIndex<Ix>

fn partial_cmp(&self, other: &EdgeIndex<Ix>) -> 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<Ix: Copy> Copy for EdgeIndex<Ix>

impl<Ix: Eq> Eq for EdgeIndex<Ix>

impl<Ix: IndexType> GraphIndex for EdgeIndex<Ix>

impl<Ix> StructuralPartialEq for EdgeIndex<Ix>