pub struct EdgeStore { /* private fields */ }Expand description
Storage for graph edges with bidirectional indexing.
Provides O(1) access to edges by ID and O(degree) access to outgoing/incoming edges for any node.
§Index Structure (EPIC-019 US-003)
by_label: Secondary index for O(k) label-based queriesoutgoing_by_label: Composite index (source, label) for O(k) filtered traversal
§CSR Snapshot (G1)
After loading from disk or after explicit build_read_snapshot(), the
csr_snapshot field provides zero-copy &[u64] access to neighbor
target IDs and edge IDs. Writes invalidate the snapshot automatically.
Implementations§
Source§impl EdgeStore
impl EdgeStore
Sourcepub fn with_capacity(expected_edges: usize, expected_nodes: usize) -> Self
pub fn with_capacity(expected_edges: usize, expected_nodes: usize) -> Self
Creates an edge store with pre-allocated capacity for better performance.
Pre-allocating reduces memory reallocation overhead when inserting many edges. With 10M edges, this can reduce peak memory usage by ~2x and improve insert throughput.
Note: when accessed through the sharded ConcurrentEdgeStore, an edge
whose endpoints hash to different shards is stored in both shards
(outgoing + incoming halves), which offsets part of that saving — with
many shards this applies to nearly all edges.
§Arguments
expected_edges- Expected number of edges to storeexpected_nodes- Expected number of unique nodes (sources + targets)
§Example
// For a graph with ~1M edges and ~100K nodes
let store = EdgeStore::with_capacity(1_000_000, 100_000);Sourcepub fn add_edge(&mut self, edge: GraphEdge) -> Result<()>
pub fn add_edge(&mut self, edge: GraphEdge) -> Result<()>
Adds an edge to the store.
Creates bidirectional index entries for efficient traversal. Also maintains label-based secondary indices (EPIC-019 US-003).
§Errors
Returns Error::EdgeExists if an edge with the same ID already exists.
Sourcepub fn add_edge_outgoing_only(&mut self, edge: GraphEdge) -> Result<()>
pub fn add_edge_outgoing_only(&mut self, edge: GraphEdge) -> Result<()>
Adds an edge with only the outgoing index (for cross-shard storage).
Used by ConcurrentEdgeStore when source and target are in different shards.
The edge is stored and indexed by source node only.
§Errors
Returns Error::EdgeExists if an edge with the same ID already exists.
Sourcepub fn add_edge_incoming_only(&mut self, edge: GraphEdge) -> Result<()>
pub fn add_edge_incoming_only(&mut self, edge: GraphEdge) -> Result<()>
Adds an edge with only the incoming index (for cross-shard storage).
Used by ConcurrentEdgeStore when source and target are in different shards.
The edge is stored and indexed by target node only.
Note: Label indices are maintained by the source shard in ConcurrentEdgeStore.
§Errors
Returns Error::EdgeExists if an edge with the same ID already exists.
Sourcepub fn edge_count(&self) -> usize
pub fn edge_count(&self) -> usize
Returns the total number of edges in the store.
Sourcepub fn outgoing_edge_count(&self) -> usize
pub fn outgoing_edge_count(&self) -> usize
Returns the count of edges where this shard is the source (for accurate cross-shard counting).
Sourcepub fn get_outgoing(&self, node_id: u64) -> Vec<&GraphEdge>
pub fn get_outgoing(&self, node_id: u64) -> Vec<&GraphEdge>
Gets all outgoing edges from a node.
Sourcepub fn for_each_outgoing<F: FnMut(&GraphEdge)>(&self, node_id: u64, f: F)
pub fn for_each_outgoing<F: FnMut(&GraphEdge)>(&self, node_id: u64, f: F)
Invokes f for each outgoing edge from node_id without allocating a Vec.
Prefer this over get_outgoing in hot loops (e.g. BFS
frontiers) where the caller processes edges inline rather than collecting them.
Sourcepub fn outgoing_degree(&self, node_id: u64) -> usize
pub fn outgoing_degree(&self, node_id: u64) -> usize
Returns the number of outgoing edges from node_id without materializing them.
Sourcepub fn incoming_degree(&self, node_id: u64) -> usize
pub fn incoming_degree(&self, node_id: u64) -> usize
Returns the number of incoming edges to node_id without materializing them.
Sourcepub fn get_incoming(&self, node_id: u64) -> Vec<&GraphEdge>
pub fn get_incoming(&self, node_id: u64) -> Vec<&GraphEdge>
Gets all incoming edges to a node.
Sourcepub fn get_outgoing_by_label(
&self,
node_id: u64,
label: &str,
) -> Vec<&GraphEdge>
pub fn get_outgoing_by_label( &self, node_id: u64, label: &str, ) -> Vec<&GraphEdge>
Gets outgoing edges filtered by label using composite index - O(k) where k = result count.
Uses the outgoing_by_label composite index for fast lookup instead of
iterating through all outgoing edges (EPIC-019 US-003).
Sourcepub fn get_edges_by_label(&self, label: &str) -> Vec<&GraphEdge>
pub fn get_edges_by_label(&self, label: &str) -> Vec<&GraphEdge>
Gets all edges with a specific label - O(k) where k = result count.
Uses the by_label secondary index for fast lookup (EPIC-019 US-003).
Sourcepub fn get_incoming_by_label(
&self,
node_id: u64,
label: &str,
) -> Vec<&GraphEdge>
pub fn get_incoming_by_label( &self, node_id: u64, label: &str, ) -> Vec<&GraphEdge>
Gets incoming edges filtered by label.
Sourcepub fn contains_edge(&self, edge_id: u64) -> bool
pub fn contains_edge(&self, edge_id: u64) -> bool
Checks if an edge with the given ID exists.
Source§impl EdgeStore
impl EdgeStore
Sourcepub fn build_read_snapshot(&mut self)
pub fn build_read_snapshot(&mut self)
Builds a CSR snapshot from the current outgoing index.
This pre-computes contiguous arrays of target IDs, edge IDs, and
interned labels for all source nodes. After calling this, BFS
traversal uses with_neighbors() for zero-copy &[u64] access
instead of cloning full GraphEdge objects.
§When to call
- After loading from disk (graph is ready for reads)
- After a batch of mutations, before a read-heavy phase
The snapshot is automatically invalidated by any write operation.
Sourcepub fn csr_snapshot(&self) -> Option<&CsrSnapshot>
pub fn csr_snapshot(&self) -> Option<&CsrSnapshot>
Returns a reference to the CSR snapshot, if built.
Sourcepub fn has_csr_snapshot(&self) -> bool
pub fn has_csr_snapshot(&self) -> bool
Returns true if a CSR snapshot is available for zero-copy reads.
Sourcepub fn with_neighbors<F, R>(&self, source_id: u64, f: F) -> R
pub fn with_neighbors<F, R>(&self, source_id: u64, f: F) -> R
Provides zero-copy access to neighbor target IDs via a callback.
Source§impl EdgeStore
impl EdgeStore
Sourcepub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>
pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>
Deserializes an edge store from bytes.
§Errors
Returns an error if deserialization fails (e.g., corrupted data).
Sourcepub fn save_to_file(&self, path: &Path) -> Result<()>
pub fn save_to_file(&self, path: &Path) -> Result<()>
Sourcepub fn load_from_file(path: &Path) -> Result<Self>
pub fn load_from_file(path: &Path) -> Result<Self>
Loads an edge store from a file.
Automatically builds a CSR snapshot after loading for zero-copy BFS traversal (G1).
§Errors
Returns an error if file I/O or deserialization fails.
Source§impl EdgeStore
impl EdgeStore
Sourcepub fn remove_edge(&mut self, edge_id: u64)
pub fn remove_edge(&mut self, edge_id: u64)
Removes an edge by ID.
Cleans up all indices: outgoing, incoming, by_label, and outgoing_by_label.
Sourcepub fn remove_edge_outgoing_only(&mut self, edge_id: u64)
pub fn remove_edge_outgoing_only(&mut self, edge_id: u64)
Removes an edge by ID, only cleaning the outgoing index.
Used by ConcurrentEdgeStore for cross-shard cleanup.
Also cleans up label indices since they are maintained by source shard.
Sourcepub fn remove_edge_incoming_only(&mut self, edge_id: u64)
pub fn remove_edge_incoming_only(&mut self, edge_id: u64)
Removes an edge by ID, only cleaning the incoming index.
Used by ConcurrentEdgeStore for cross-shard cleanup.
Sourcepub fn remove_node_edges(&mut self, node_id: u64)
pub fn remove_node_edges(&mut self, node_id: u64)
Removes all edges connected to a node (cascade delete).
Removes both outgoing and incoming edges, cleaning up all indices including label indices (EPIC-019 US-003).
Trait Implementations§
Source§impl AdjacencySource for EdgeStore
impl AdjacencySource for EdgeStore
Source§impl<'de> Deserialize<'de> for EdgeStore
impl<'de> Deserialize<'de> for EdgeStore
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for EdgeStore
impl RefUnwindSafe for EdgeStore
impl Send for EdgeStore
impl Sync for EdgeStore
impl Unpin for EdgeStore
impl UnsafeUnpin for EdgeStore
impl UnwindSafe for EdgeStore
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);