Struct Graph 

pub struct Graph { /* private fields */ }

Graph container — the one Core-free namespace + mount-tree handle (canonical §3, D246).

Clone is a cheap Rc bump; a subgraph (from mount*/ancestors) is just a Graph into a child level. Intentionally !Send + !Sync (D246/S2c single-owner): no Core, no borrow — captured into owner-side sinks on the one thread that owns the Core. Pass the embedder’s &Core (e.g. owned.core()) into every Core-touching method.

Implementations

impl Graph

pub fn new(name: impl Into<String>) -> Self

Construct a named, empty root graph. D246: the graph is Core-free — the embedder owns the Core (see graphrefly_core::OwnedCore) and passes &Core into Core-touching ops.

pub fn is_valid_name(name: &str) -> bool

Whether name is a legal local node/subgraph name.

pub fn name(&self) -> String

The graph’s name as set at construction (or via mount).

pub fn subscribe_namespace_change(&self, sink: Arc<dyn Fn(&Core)>) -> u64

Subscribe to namespace changes (add, remove, mount, unmount, destroy). The sink fires AFTER the inner lock is dropped, with the owner’s &Core. Returns a subscription id.

pub fn unsubscribe_namespace_change(&self, id: u64)

Unsubscribe a namespace-change sink by id (owner-invoked, D246 rule 3 — no RAII below the binding).

pub fn describe(&self, core: &Core) -> GraphDescribeOutput

Snapshot the graph’s topology + lifecycle state (JSON form). value fields are raw u64 handles.

pub fn describe_with_debug( &self, core: &Core, debug: &dyn DebugBindingBoundary, ) -> GraphDescribeOutput

Self::describe with each value rendered via debug.

pub fn describe_reactive( &self, core: &Core, sink: &DescribeSink, ) -> ReactiveDescribeHandle

Subscribe to live topology snapshots (canonical §3.6.1 reactive: true). Push-on-subscribe + re-fires on namespace changes and set_deps. D246 rule 3: returns an id-bearing handle with an explicit owner-invoked ReactiveDescribeHandle::detach — no RAII Drop.

pub fn observe(&self, path: &str) -> GraphObserveOne

Tap a single node’s downstream message stream. Pure-namespace resolution; pass &Core to the returned handle’s subscribe.

pub fn observe_all(&self) -> GraphObserveAll

Tap every named node in this graph (snapshot at subscribe()).

pub fn observe_all_reactive(&self) -> GraphObserveAllReactive

Tap every named node AND auto-subscribe late-added nodes.

pub fn fire_namespace_change(&self, core: &Core)

Fire all namespace-change sinks owner-side (D246 rule 2 — caller holds &Core).

pub fn add( &self, core: &Core, node_id: NodeId, name: impl Into<String>, ) -> Result<NodeId, NameError>

Register an existing node_id under name in this graph’s namespace.

Errors

See NameError.

pub fn node(&self, path: &str) -> NodeId

Resolve a path to a NodeId. Panics if missing.

pub fn try_resolve(&self, path: &str) -> Option<NodeId>

Non-panicking Self::node.

pub fn try_resolve_checked( &self, path: &str, ) -> Result<Option<NodeId>, PathError>

Path resolution with typed errors (pure-namespace; never touches Core).

Errors

See PathError.

pub fn name_of(&self, node_id: NodeId) -> Option<String>

Reverse lookup: the local name for a node_id.

pub fn node_count(&self) -> usize

Number of named nodes in this graph.

pub fn node_names(&self) -> Vec<String>

Snapshot of local node names in insertion order.

pub fn child_names(&self) -> Vec<String>

Snapshot of mounted child names in insertion order.

pub fn is_destroyed(&self) -> bool

Returns true after Self::destroy has been called.

pub fn state( &self, core: &Core, name: impl Into<String>, initial: Option<HandleId>, ) -> Result<NodeId, NameError>

Register a state node under name.

Errors

See NameError.

pub fn derived( &self, core: &Core, name: impl Into<String>, deps: &[NodeId], fn_id: FnId, equals: EqualsMode, ) -> Result<NodeId, NameError>

Register a static-derived node (fn fires on every dep change).

Errors

See NameError.

pub fn dynamic( &self, core: &Core, name: impl Into<String>, deps: &[NodeId], fn_id: FnId, equals: EqualsMode, ) -> Result<NodeId, NameError>

Register a dynamic-derived node (fn declares read dep indices).

Errors

See NameError.

pub fn set(&self, core: &Core, name: &str, handle: HandleId)

Emit a value on a named state node.

pub fn get(&self, core: &Core, name: &str) -> HandleId

Read the cached value of a named node.

pub fn invalidate_by_name(&self, core: &Core, name: &str)

Clear the cache of a named node and cascade [INVALIDATE].

pub fn complete_by_name(&self, core: &Core, name: &str)

Mark a named node terminal with COMPLETE.

pub fn error_by_name(&self, core: &Core, name: &str, error_handle: HandleId)

Mark a named node terminal with ERROR.

pub fn remove( &self, core: &Core, name: &str, ) -> Result<GraphRemoveAudit, RemoveError>

Remove a named node OR mounted subgraph (R3.2.3 / R3.7.3 ordering — namespace cleared AFTER the TEARDOWN cascade).

Errors

See RemoveError.

pub fn edges(&self, core: &Core, recursive: bool) -> Vec<(String, String)>

Derive [from, to] edge name pairs. recursive qualifies names across the mount tree with ::.

pub fn subscribe( &self, core: &Core, node_id: NodeId, sink: Sink, ) -> SubscriptionId

Subscribe a sink. Returns a SubscriptionId; pass it back to Self::unsubscribe (owner-invoked, synchronous — D246 rule 3; no RAII below the binding).

pub fn unsubscribe(&self, core: &Core, node_id: NodeId, sub_id: SubscriptionId)

Detach a sink previously registered via Self::subscribe.

pub fn unsubscribe_topology(&self, core: &Core, id: TopologySubscriptionId)

Detach a Core topology subscription by id.

pub fn emit(&self, core: &Core, node_id: NodeId, new_handle: HandleId)

Emit a value on a state node.

pub fn cache_of(&self, core: &Core, node_id: NodeId) -> HandleId

Read a node’s current cache.

pub fn has_fired_once(&self, core: &Core, node_id: NodeId) -> bool

Whether the node’s fn has fired at least once.

pub fn complete(&self, core: &Core, node_id: NodeId)

Mark the node terminal with COMPLETE.

pub fn error(&self, core: &Core, node_id: NodeId, error_handle: HandleId)

Mark the node terminal with ERROR.

pub fn teardown(&self, core: &Core, node_id: NodeId)

Tear the node down (R2.6.4).

pub fn invalidate(&self, core: &Core, node_id: NodeId)

Clear the node’s cache and cascade [INVALIDATE].

pub fn pause( &self, core: &Core, node_id: NodeId, lock_id: LockId, ) -> Result<(), PauseError>

Acquire a pause lock.

Errors

See PauseError.

pub fn resume( &self, core: &Core, node_id: NodeId, lock_id: LockId, ) -> Result<Option<ResumeReport>, PauseError>

Release a pause lock.

Errors

See PauseError.

pub fn alloc_lock_id(&self, core: &Core) -> LockId

Allocate a fresh LockId.

pub fn set_deps( &self, core: &Core, n: NodeId, new_deps: &[NodeId], ) -> Result<(), SetDepsError>

Atomically rewire a node’s deps.

Errors

See SetDepsError.

Hazards

Re-entrant set_deps from inside the firing node’s own fn corrupts Dynamic tracked indices (D1 in ~/src/graphrefly-rs/docs/porting-deferred.md). Acceptable v1: most callers are external orchestrators, not the firing node.

pub fn set_resubscribable( &self, core: &Core, node_id: NodeId, resubscribable: bool, )

Mark the node as resubscribable (R2.2.7).

pub fn add_meta_companion(&self, core: &Core, parent: NodeId, companion: NodeId)

Attach companion as a meta companion of parent (R1.3.9.d).

pub fn batch<F: FnOnce()>(&self, core: &Core, f: F)

Coalesce multiple emissions into a single wave.

pub fn signal(&self, core: &Core, kind: SignalKind)

General broadcast (canonical R3.7.1).

pub fn signal_invalidate(&self, core: &Core)

Broadcast [INVALIDATE] across this graph + mount tree (meta-companion filtered per R3.7.2; Graph locks dropped before any Core::invalidate). Idempotent on a destroyed graph.

pub fn destroy(&self, core: &Core)

Tear down every named node + recursively into mounted children, then clear namespace + mount-tree state. R3.7.3 ordering (children-first, then own teardown, then clear, then fire ns-change) preserved verbatim.

pub fn mount( &self, core: &Core, name: impl Into<String>, child: &Graph, ) -> Result<Graph, MountError>

Embed an existing child subgraph under name. Fires ns-change sinks owner-side (P3) — hence &Core (D246 rule 2).

Errors

See MountError.

pub fn mount_new( &self, core: &Core, name: impl Into<String>, ) -> Result<Graph, MountError>

Create an empty subgraph (shares the embedder’s one Core).

Errors

See MountError.

pub fn mount_with<F: FnOnce(&Graph)>( &self, core: &Core, name: impl Into<String>, builder: F, ) -> Result<Graph, MountError>

Builder pattern: create an empty subgraph, run builder, return it.

Errors

See MountError.

pub fn unmount( &self, core: &Core, name: &str, ) -> Result<GraphRemoveAudit, MountError>

Detach a previously-mounted subgraph (TEARDOWN cascade).

Errors

See MountError.

pub fn ancestors(&self, include_self: bool) -> Vec<Graph>

Parent chain (root last). include_self = true prepends this graph.

impl Graph

pub fn snapshot(&self, core: &Core) -> GraphPersistSnapshot

Serialize this graph’s state into a portable snapshot.

pub fn snapshot_full(&self, core: &dyn CoreFull) -> GraphPersistSnapshot

Self::snapshot over the one object-safe facade (D246 rule 5) — for the storage in-wave MailboxOp::Defer(|cf: &dyn CoreFull|) path, which only has a &dyn CoreFull (not a concrete &Core). Read-only; serialize_handle delegates to the binding.

pub fn restore( &self, core: &Core, snapshot: &GraphPersistSnapshot, ) -> Result<(), SnapshotError>

Restore state from a snapshot into this existing graph.

Errors

NameMismatch if names differ; UnknownNode/UnknownSubgraph for snapshot entries absent from the graph.

pub fn from_snapshot( core: &Core, snapshot: &GraphPersistSnapshot, builder: Option<SnapshotBuilder>, factories: Option<IndexMap<String, NodeFactory>>, ) -> Result<Self, SnapshotError>

Reconstruct a graph from a snapshot. Builder mode (builder = Some): build topology then restore() values. Auto-hydration (builder = None): reconstruct topology + state from the snapshot via factories (state nodes need none).

D246: the embedder owns the Core (see graphrefly_core::OwnedCore) and passes it in; the binding is core.binding_ptr().

Errors

UnresolvableDeps if auto-hydration can’t resolve a node’s deps; MissingFactory for a non-state node type with no factory.

Trait Implementations

impl Clone for Graph

fn clone(&self) -> Graph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Graph

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.