Struct plexus::graph::EdgeView

pub struct EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry,  { /* fields omitted */ }

View of an edge in a graph.

Provides traversals, queries, and mutations related to edges in a graph. See the module documentation for more information about topological views.

An edge connecting a vertex $A$ and a vertex $B$ is notated $\overleftrightarrow{AB}$ or $\overleftrightarrow{BA}$ (both representing the same edge). Typically, edges are described by one of their arcs (e.g., "the edge of $\overrightarrow{AB}$").

Methods

impl<M, G> EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry, 

pub fn key(&self) -> EdgeKey

Gets the key for the edge.

impl<'a, M, G> EdgeView<&'a mut M, G> where
    M: 'a + AsStorage<EdgePayload<G>> + AsStorageMut<EdgePayload<G>>,
    G: 'a + GraphGeometry, 

pub fn into_orphan(self) -> EdgeOrphan<'a, G>

Converts a mutable view into an orphan view.

pub fn into_ref(self) -> EdgeView<&'a M, G>

Converts a mutable view into an immutable view.

This is useful when mutations are not (or no longer) needed and mutual access is desired.

impl<M, G> EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<EdgePayload<G>> + Consistent,
    G: GraphGeometry, 

pub fn into_arc(self) -> ArcView<M, G>

pub fn arc(&self) -> ArcView<&M::Target, G>

pub fn is_boundary_edge(&self) -> bool

impl<M, G> EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<EdgePayload<G>> + AsStorage<VertexPayload<G>> + Consistent,
    G: GraphGeometry, 

pub fn midpoint(&self) -> VertexPosition<G> where
    G: EdgeMidpoint,
    G::Vertex: AsPosition, 

Trait Implementations

impl<M, G> CompositeEdge<M, G> for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<ArcPayload<G>> + AsStorage<EdgePayload<G>> + Consistent,
    G: GraphGeometry, 

fn into_arc(self) -> ArcView<M, G>

fn into_edge(self) -> EdgeView<M, G>

impl<M, G> PayloadBinding for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry, 

type Key = EdgeKey

type Payload = EdgePayload<G>

fn key(&self) -> Self::Key

Gets the key for the view.

fn rekey<T, M>(self, key: T::Key) -> Result<T, GraphError> where
    Self: Into<View<M, Self::Payload>>,
    T: From<View<M, <T as PayloadBinding>::Payload>> + PayloadBinding,
    M: Reborrow,
    M::Target: AsStorage<Self::Payload> + AsStorage<T::Payload>, 

Rekeys a view into another.

impl<M, G> Clone for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry,
    View<M, EdgePayload<G>>: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, G> Copy for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry,
    View<M, EdgePayload<G>>: Copy, 

impl<M, G> PartialEq<EdgeView<M, G>> for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>> + Consistent,
    G: GraphGeometry, 

fn eq(&self, other: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<M, G> Deref for EdgeView<M, G> where
    M: Reborrow,
    M::Target: AsStorage<EdgePayload<G>>,
    G: GraphGeometry, 

type Target = EdgePayload<G>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M, G> DerefMut for EdgeView<M, G> where
    M: Reborrow + ReborrowMut,
    M::Target: AsStorage<EdgePayload<G>> + AsStorageMut<EdgePayload<G>>,
    G: GraphGeometry, 

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.