Docs.rs
  • graph-api-lib-0.1.3
    • graph-api-lib 0.1.3
    • Docs.rs crate page
    • Apache-2.0
    • Links
    • Documentation
    • Repository
    • crates.io
    • Source
    • Owners
    • BrynCooke
    • Dependencies
      • derivative ^2.2.0 normal
      • include-doc ^0.2.1 normal
      • petgraph ^0.8.0 normal optional
      • uuid ^1.11.0 normal
    • Versions
    • 75.48% of the crate is documented
  • Go to latest version
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate graph_api_lib

graph_api_lib0.1.3

  • All Items

Crate Items

  • Structs
  • Enums
  • Traits

Crates

  • graph_api_lib

Crate graph_api_lib

Source

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.

Results

Settings
Help
    trait
    graph_api_lib::EdgeReference
    A reference to an edge in a graph.
    assoc type
    graph_api_lib::Graph::EdgeReference
    An edge reference is used during walking over edges. It …
    trait
    graph_api_lib::EdgeReferenceMut
    A mutable reference to an edge in a graph. This trait …
    assoc type
    graph_api_lib::Graph::EdgeReferenceMut
    A mut edge reference to modify the edge.
    trait method
    graph_api_lib::EdgeReference::id
    &EdgeReference ->
    Returns the identifier of the edge.
    trait method
    graph_api_lib::EdgeReference::head
    &EdgeReference ->
    Returns the identifier of the head vertex of the edge.
    trait method
    graph_api_lib::EdgeReference::tail
    &EdgeReference ->
    Returns the identifier of the tail vertex of the edge.
    trait method
    graph_api_lib::EdgeReference::weight
    &EdgeReference -> &
    Returns a reference to the weight of the edge.
    trait method
    graph_api_lib::EdgeReference::project
    &EdgeReference -> Option<T>
    Project the element to a struct representing a single …
    trait method
    graph_api_lib::Graph::edge
    &Graph, Graph::EdgeId -> Option<Graph::EdgeReference>
    where
    Graph::EdgeReference: EdgeReference<Graph>
    Gets the edge with the specified identifier.