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

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.