Struct SimpleGraph

pub struct SimpleGraph<Vertex, Edge>
where
    Vertex: Element,
    Edge: Element,
{ /* private fields */ }

A graph that is backed by a simple in-memory data structure.

Implementations

impl<Vertex, Edge> SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

pub fn new() -> Self

Trait Implementations

impl<Vertex, Edge> Debug for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

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

Formats the value using the given formatter.

impl<Vertex, Edge> Default for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

fn default() -> Self

Returns the “default value” for a type.

impl<Vertex, Edge> Graph for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

type Vertex = Vertex

The type of the vertices in the graph. This is usually an enum.

type Edge = Edge

The type of the edges in the graph. This is usually an enum.

type VertexId = VertexId

The VertexId type of the graph.

type EdgeId = EdgeId

The EdgeId type of the graph.

type VertexReference<'graph> = VertexReference<'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

A reference to a vertex.

type VertexReferenceMut<'graph> = VertexReferenceMut<'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

A mut reference to a vertex.

type EdgeReference<'graph> = EdgeReference<'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

An edge reference is used during walking over edges. It includes the id, tail, head and weight of the edge.

type EdgeReferenceMut<'graph> = EdgeReferenceMut<'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

A mut edge reference to modify the edge.

type EdgeIter<'search, 'graph> = EdgeIter<'search, 'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

An iterator over the edge references.

type VertexIter<'search, 'graph> = VertexIter<'search, 'graph, SimpleGraph<Vertex, Edge>> where Self: 'graph

An iterator over the vertex references.

fn add_vertex(&mut self, vertex: Self::Vertex) -> Self::VertexId

Adds a vertex to the graph and returns its identifier.

fn add_edge( &mut self, from: Self::VertexId, to: Self::VertexId, edge: Self::Edge, ) -> Self::EdgeId

Adds an edge to the graph and returns its identifier.

fn vertex(&self, id: Self::VertexId) -> Option<Self::VertexReference<'_>>

Gets the vertex with the specified identifier.

fn vertex_mut( &mut self, id: Self::VertexId, ) -> Option<Self::VertexReferenceMut<'_>>

Returns the vertex with the specified identifier.

fn vertices<'search>( &self, search: &VertexSearch<'search, Self>, ) -> Self::VertexIter<'search, '_>

Iterate over vertex identifiers. Graphs should try to narrow down the returned vertices using the search criteria, but overfetch will be filtered.

fn edge(&self, id: Self::EdgeId) -> Option<Self::EdgeReference<'_>>

Gets the edge with the specified identifier.

fn edge_mut(&mut self, edge: Self::EdgeId) -> Option<Self::EdgeReferenceMut<'_>>

Gets the edge with the specified identifier.

fn edges<'search>( &self, vertex: Self::VertexId, search: &EdgeSearch<'search, Self>, ) -> Self::EdgeIter<'search, '_>

Returns an iterator over the edges of a vertex. Graphs should try to narrow down the returned edges using the search criteria, but overfetch will be filtered.

fn clear(&mut self)

Clears the graph. Default implementation returns an error. Implement the SupportsClear trait to provide this functionality.

fn dbg<T>(&self, id: T) -> String

where T: Into<ElementId<Self>>,

Returns a string representation of an element in the graph.

fn walk(&self) -> StartWalkerBuilder<'_, ImmutableMarker, Self, ()>

where Self: Sized,

Returns an immutable walker builder for the graph.

fn walk_mut(&mut self) -> StartWalkerBuilder<'_, MutableMarker, Self, ()>

where Self: Sized,

Returns a mutable walker builder for the graph.

impl<Vertex, Edge> SupportsClear for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

fn clear(&mut self)

Clears the graph, removing all vertices and edges

impl<Vertex, Edge> SupportsElementRemoval for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

fn remove_vertex(&mut self, id: Self::VertexId) -> Option<Self::Vertex>

Removes a vertex from the graph and returns the vertex.

fn remove_edge(&mut self, edge: Self::EdgeId) -> Option<Self::Edge>

Removes an edge from the graph and returns the edge.

impl<Vertex, Edge> SupportsEdgeAdjacentLabelIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsEdgeHashIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsEdgeLabelIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsEdgeRangeIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsVertexFullTextIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsVertexHashIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsVertexLabelIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,

impl<Vertex, Edge> SupportsVertexRangeIndex for SimpleGraph<Vertex, Edge>

where Vertex: Element, Edge: Element,