Struct SharedGraph 

pub struct SharedGraph { /* private fields */ }

Thread-safe, clonable handle to an EntityGraph.

Uses parking_lot::RwLock for reader-writer locking, allowing concurrent reads with exclusive writes. Cloning shares the underlying graph (via Arc).

Write operations automatically send the new graph version on an internal broadcast channel. Call subscribe to get a receiver.

Implementations

impl SharedGraph

pub fn new(graph: EntityGraph) -> Self

Wrap an EntityGraph in a thread-safe handle.

pub fn subscribe(&self) -> Receiver<u64>

Subscribe to graph change notifications.

Returns a receiver that yields the new graph version after each write operation (add, update, remove).

pub fn subscribe_with_version(&self) -> (Receiver<u64>, u64)

Subscribe and atomically capture the current version under the read lock.

This avoids a TOCTOU race where a write could occur between subscribing and reading the version.

pub fn subscriber_count(&self) -> usize

Number of active subscribers.

pub fn read<F, R>(&self, f: F) -> R

where F: FnOnce(&EntityGraph) -> R,

Execute a closure with shared (read) access to the graph.

pub fn write<F, R>(&self, f: F) -> R

where F: FnOnce(&mut EntityGraph) -> R,

Execute a closure with exclusive (write) access to the graph.

pub fn add(&self, entity: HDict) -> Result<String, GraphError>

Add an entity. See EntityGraph::add.

pub fn get(&self, ref_val: &str) -> Option<HDict>

Get an entity by ref value.

Returns an owned clone because the read lock is released before the caller uses the value.

pub fn update(&self, ref_val: &str, changes: HDict) -> Result<(), GraphError>

Update an entity. See EntityGraph::update.

pub fn remove(&self, ref_val: &str) -> Result<HDict, GraphError>

Remove an entity. See EntityGraph::remove.

pub fn read_filter( &self, filter_expr: &str, limit: usize, ) -> Result<HGrid, GraphError>

Run a filter expression and return a grid.

pub fn len(&self) -> usize

Number of entities.

pub fn is_empty(&self) -> bool

Returns true if the graph has no entities.

pub fn all_entities(&self) -> Vec<HDict>

Return all entities as owned clones.

pub fn contains(&self, ref_val: &str) -> bool

Check if an entity with the given ref value exists.

pub fn version(&self) -> u64

Current graph version.

pub fn read_all( &self, filter_expr: &str, limit: usize, ) -> Result<Vec<HDict>, GraphError>

Run a filter and return matching entity dicts (cloned).

pub fn refs_from(&self, ref_val: &str, ref_type: Option<&str>) -> Vec<String>

Get ref values that the given entity points to.

pub fn refs_to(&self, ref_val: &str, ref_type: Option<&str>) -> Vec<String>

Get ref values of entities that point to the given entity.

pub fn changes_since( &self, version: u64, ) -> Result<Vec<GraphDiff>, ChangelogGap>

Get changelog entries since a given version.

Returns Err(ChangelogGap) if the requested version has been evicted.

pub fn validate(&self) -> Vec<ValidationIssue>

Validate all entities against the namespace and check for dangling refs.

See EntityGraph::validate.

pub fn ref_chain(&self, ref_val: &str, ref_tags: &[&str]) -> Vec<HDict>

Walk a chain of ref tags. See EntityGraph::ref_chain.

pub fn site_for(&self, ref_val: &str) -> Option<HDict>

Resolve the site for any entity. See EntityGraph::site_for.

pub fn children(&self, ref_val: &str) -> Vec<HDict>

All direct children of an entity. See EntityGraph::children.

pub fn equip_points( &self, equip_ref: &str, filter: Option<&str>, ) -> Result<Vec<HDict>, GraphError>

All points for an equip, optionally filtered. See EntityGraph::equip_points.

pub fn hierarchy_tree( &self, root: &str, max_depth: usize, ) -> Option<HierarchyNode>

Build a hierarchy tree. See EntityGraph::hierarchy_tree.

pub fn classify(&self, ref_val: &str) -> Option<String>

Classify an entity. See EntityGraph::classify.

Trait Implementations

impl Clone for SharedGraph

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SharedGraph

fn default() -> Self

Returns the “default value” for a type.