Struct petgraph::graph::EdgeIndex

pub struct EdgeIndex<Ix = DefaultIx>(_);

Edge identifier.

Methods

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> VisitMap<EdgeIndex<Ix>> for FixedBitSet where
    Ix: IndexType, 

fn visit(&mut self, x: EdgeIndex<Ix>) -> bool

Mark a as visited.

fn is_visited(&self, x: &EdgeIndex<Ix>) -> bool

Return whether a has been visited before.

impl<Ix> Serialize for EdgeIndex<Ix> where
    Ix: IndexType + Serialize, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de, Ix> Deserialize<'de> for EdgeIndex<Ix> where
    Ix: IndexType + Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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 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: Copy> Copy for EdgeIndex<Ix>

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: Default> Default for EdgeIndex<Ix>

fn default() -> EdgeIndex<Ix>

Returns the "default value" for a type.

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

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

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

fn ne(&self, __arg_0: &EdgeIndex<Ix>) -> bool

This method tests for !=.

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

fn partial_cmp(&self, __arg_0: &EdgeIndex<Ix>) -> Option<Ordering>

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

fn lt(&self, __arg_0: &EdgeIndex<Ix>) -> bool

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

fn le(&self, __arg_0: &EdgeIndex<Ix>) -> bool

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

fn gt(&self, __arg_0: &EdgeIndex<Ix>) -> bool

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

fn ge(&self, __arg_0: &EdgeIndex<Ix>) -> bool

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

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

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

fn cmp(&self, __arg_0: &EdgeIndex<Ix>) -> 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.

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

fn hash<__HIx: Hasher>(&self, __arg_0: &mut __HIx)

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<Ix: Debug> Debug for EdgeIndex<Ix>

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

Formats the value using the given formatter.

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> 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<Ix: IndexType> GraphIndex for EdgeIndex<Ix>

fn index(&self) -> usize

fn is_node_index() -> bool