Expand description
§graphersal - Graphersal In-Memory Graph Traversal Engine
An in-memory graph traversal engine inspired by Apache TinkerPop Gremlin.
§Quick Start
use graphersal::prelude::*;
let graph = TraversalGraph::new();
let g = graph.traversal();
let count = g.v(None::<()>).count().next().unwrap();
assert!(count.is_some());Re-exports§
pub use error::TraverserError;
Modules§
- alloc_
tracking - Exact, allocator-level per-step memory tracking (D4 of the memory-inspection spec). Entirely
behind the
alloc-trackingfeature: with the feature off, this module does not exist in the compiled crate at all, not merely disabled code. - auth
- Authorization: who may do what to which resource.
- catalog
- The catalog: named definitions stored beside the schema (saved queries, compression rules and host-defined kinds 128-255).
- changes
- Change capture and commit hooks: what one committed unit of work changed.
- error
- Error types and their diagnostic (
help()) text. - exec
- Execution control for hosts: limits and their locks, cancellation, result rendering.
- io
- High-level I/O abstractions, facades, and format-specific importers/exporters.
- persist
- Persistence over streams (feature
persist): the binary storage format specified in the book’s “Storage Format Specification” (book/src/persistence/format.md; “format spec N” in the comments of this module names its section N). User documentation: the book’s “Persistence” part (book/src/persistence/). - prelude
- Everything to write queries:
use graphersal::prelude::*;. - profile
- Profiling: the metrics that
.profile(),.profile_with(..)andexecute()return. - schema
- Schemas: the format, enforcement modes, validation, inference, diff, patch and visualization.
- script
- The Rhai script DSL.
- storage
- The storage extension point: the
GraphStoragetrait and every type in its signatures.
Structs§
- Compact
String - The small-string type of labels, property keys and string values, re-exported from
compact_str(the only third-party type of the public API); seeprelude::CompactString. ACompactStringis a compact string type that can be used almost anywhere aStringorstrcan be used. - Graph
Source - Factory for constructing shared
Graphinstances. - Graph
Traversal Source - Primary entry point for constructing and executing Gremlin-style graph traversals.
- Traversal
Graph - In-memory graph structure holding vertices, edges, and property maps.
Enums§
- Element
Property - Represents strongly-typed property values attached to graph elements or computed stream items.
- Traverser
Value - Values carried by
Traverseritems during step evaluation.