Crate graph_api_lib

Structs§

EdgeSearch: A search to apply to edges when querying a graph. This allows graph implementations to support vertex centric indexes. In the future, this will be expanded to support more complex filters than just label and direction.
EdgeWalkerBuilder: A builder for edge-focused graph traversals.
ValueRange: A range of Values for range-based queries and indexes.
VertexWalkerBuilder: A builder for vertex-focused graph traversals.
WalkerBuilder: A generic builder for graph walkers.

Enums§

Direction: The direction of an edge in a graph.
ElementId: An identifier for a vertex or an edge in a graph.
IndexType: The type of index
Value: A polymorphic value type for graph element properties.
VertexSearch: A search to apply to vertices when querying a graph.

Traits§

EdgeReference: A reference to an edge in a graph.
EdgeReferenceMut: A mutable reference to an edge in a graph. This trait extends the EdgeReference trait and provides a method to obtain a mutable reference to the weight of the edge.
EdgeWalker: Trait for walking over edges in a graph.
Element: An element in a graph. This is either an edge or a vertex.
Graph: Graphs that implement this trait can be used with the walker API.
Index: An Index is a fast lookup mechanism for graph elements.
Label: A label for an Element. This can be either a vertex or an edge.
MutationListener: Trait to allow graphs to react to mutation of elements. When an indexed element is updated the mutation listener is called with the index and the before and after values.
Project: Enables projecting a graph element weight to a specific type.
ProjectMut: Enables projecting a graph element weight to a mutable specific type.
SupportsClear: Supports clearing all vertices and edges
SupportsEdgeAdjacentLabelIndex: Supports indexing of edges by adjacent vertex label
SupportsEdgeHashIndex: Supports indexing of edges by field using a hash index
SupportsEdgeLabelIndex: Supports indexing of edges by label
SupportsEdgeRangeIndex: Supports indexing of edges by field with range queries
SupportsElementRemoval: Supports removal of individual vertices and edges
SupportsVertexFullTextIndex: Supports indexing of vertices by field using a full text index
SupportsVertexHashIndex: Supports indexing of vertices by field using a hash index
SupportsVertexLabelIndex: Supports indexing of vertices by label
SupportsVertexRangeIndex: Supports indexing of vertices by field with range queries
VertexReference
VertexReferenceMut
VertexWalker: A trait that defines the basic behavior of a vertex walker, which is a specialized type of graph walker that focuses on traversing and exploring the vertices in a graph.
Walker: A trait that defines the basic behavior of a graph walker.

Results

Help

graph_api_lib::Walker

A trait that defines the basic behavior of a graph walker.

graph_api_lib::WalkerBuilder::walker

Returns a mutable reference to the underlying walker.

graph_api_lib::VertexWalkerBuilder::walker

Consumes the builder and returns the underlying walker.

graph_api_lib::EdgeWalkerBuilder::walker

Consumes the builder and returns the underlying walker.

graph_api_lib::WalkerBuilder

A generic builder for graph walkers.

graph_api_lib::EdgeWalker

Trait for walking over edges in a graph.

graph_api_lib::EdgeWalkerBuilder

A builder for edge-focused graph traversals.

graph_api_lib::VertexWalker

A trait that defines the basic behavior of a vertex …

graph_api_lib::VertexWalkerBuilder

A builder for vertex-focused graph traversals.

graph_api_lib::VertexWalkerBuilder::with_edge_walker

Transforms the current vertex walker into an edge walker.

graph_api_lib::EdgeWalkerBuilder::with_edge_walker

Transforms the current walker into another edge walker.

graph_api_lib::VertexWalkerBuilder::with_vertex_walker

Transforms the current vertex walker into another vertex …

graph_api_lib::EdgeWalkerBuilder::with_vertex_walker

Transforms the current walker into a vertex walker.

graph_api_lib::Graph::walk

Returns an immutable walker builder for the graph.

graph_api_lib::Walker::ctx

&Walker -> &Walker::Context

Returns the current context of the walker.

graph_api_lib::Walker::ctx_mut

&mut Walker -> &mut Walker::Context

Returns the mutable current context of the walker.

graph_api_lib::Walker::next_element

&mut Walker, &Walker::Graph -> Option<ElementId<Walker::Graph>>

Return the next element in the traversal.

graph_api_lib::WalkerBuilder::walker

&mut WalkerBuilder<Mutability, Graph, Walker> -> &mut Walker

Walker: Walker

Returns a mutable reference to the underlying walker.

graph_api_lib::VertexWalker::detour

VertexWalker, Path -> <VertexWalker, Path, Terminal>

Terminal: Walker