Expand description
GraphReFly Graph container — sugar layer over graphrefly_core::Core
with named namespace, mount/unmount composition, describe() JSON
introspection, and observe() sink-style message tap.
§Status (M2 Slice E+ — 2026-05-05)
Read-side introspection + composition slice. Lands the canonical-spec
Graph surface for state / derived / dynamic named sugar
(§3.9), add / node / name_of / try_resolve namespace (§3.5),
mount / mount_new / mount_with / unmount / ancestors
composition (§3.4), destroy / signal_invalidate lifecycle (§3.7),
describe() JSON form (§3.6 + Appendix B), and observe() /
observe_all() default sink-style tap (§3.6.2).
Hard-breaks the M2 starter (Slice D) sugar API: state(name, initial)
replaces state(initial), etc. Pre-1.0 — no compat shims (per
feedback_no_backward_compat.md).
Out of scope (subsequent slices):
- Reactive
describe()/observe()—Node<GraphDescribeOutput>andNode<ObserveChangeset>modes (§3.6.1 / §3.6.2 reactive variants). Need a Core-level topology-change notification primitive. - Async-iterable
observe()modes —structured/timeline/causal/derivedopts. describe()non-JSON formats — pretty / mermaid / d2 / stage-log.describe({ explain })/describe({ reachable })— causal chain + reachability walks.- Snapshot / restore + content addressing — V1 lazy CID / V2 schema validation / V3 caps + cross-graph refs (§3.8 + Phase 6).
mutate()factory — DS-14 RAII + audit append substrate.- Cross-Core (multi-binding) mount — open question 1 in
archive/docs/SESSION-rust-port-architecture.mdPart 6; post-M6. - Meta annotations + versioning fields in describe output — need metadata-storage primitive on Core.
§Crate lints
#![forbid(unsafe_code)] per workspace policy.
Structs§
- Edge
Describe - Edge between two named nodes (or a named node and
_anon_<NodeId>). - Graph
- Graph container — the one Core-free namespace + mount-tree handle (canonical §3, D246).
- Graph
Describe Output - Top-level
describe()output (canonical Appendix B JSON schema). - Graph
Inner - Inner namespace + mount-tree state for one graph level. D246: holds
no
Core— purely the named namespace, the mounted children, and the namespace-change sinks. D246/S2c/D247: single-owner ⇒Rc<RefCell<GraphInner>>(the priorArc<Mutex<…>>was shared-Core-era legacy); the shareable-handle + parent-Weakcycle stays, single-threaded. - Graph
Observe All - All-nodes observe handle. Subscriptions are tied to the set of
nodes named at
subscribe()call time. D246: no RAIIDrop— You MUST callSelf::detach(core)(owner-invoked) — these Core subscriptions are opened via rawcore.subscribeand are NOTOwnedCore-tracked, so dropping the handle withoutdetachleaks them for theCorelifetime. - Graph
Observe AllReactive - Reactive
observe_all— auto-subscribes late-added named nodes via the owner-side namespace-change listener, and prunes torn-down nodes via the Core topology sub (the pruneunsubscribeisMailboxOp::Defer’d sinceNodeTornDownfires in-wave — D246 r6). D246 rule 3: no RAIIDrop; teardown is the owner-invokedSelf::detach(core)— owner-invoked, REQUIRED. The ns-sink is collected bygraph.destroy(core); the Core topology sub + fan-out subs are opened via rawcore.subscribe*and are NOTOwnedCore-tracked, sodetach(core)is the only thing that collects them (dropping the handle without it leaks them). - Graph
Observe One - Single-node observe handle (canonical §3.6.2). D246: holds a
Core-free
Graph;&Coreis passed per call. - Graph
Persist Snapshot - Portable snapshot of a graph’s state.
- Graph
Remove Audit - Result of
Graph::unmount/Graph::remove. - Node
Describe - Per-node descriptor.
- Node
Slice - Per-node state within a snapshot.
- Observe
Sub - Id pair for a single observe subscription. D246: a plain value (no
Drop); detach explicitly viaSelf::detachor let the embedder’sOwnedCoretear down on owner-thread drop. - Reactive
Describe Handle - Id-bearing handle for a reactive describe subscription.
Enums§
- Describe
Value - Per-node cache value in
describeoutput. Serialized uniformly without an enum tag. - Mount
Error - Errors from
mount/mount_new/unmount. - Name
Error - Errors from name registration.
- Node
Snapshot Status - Lifecycle status stored in a snapshot.
- Node
Status - Canonical Appendix B
statusenum. - Node
Type Str - Canonical Appendix B
typeenum. - Path
Error - Path resolution errors returned by
Graph::try_resolve_checked. - Remove
Error - Errors from
Graph::remove. - Signal
Kind - Signal kind for
Graph::signal(canonical R3.7.1). - Snapshot
Error - Errors from
Graph::restoreandGraph::from_snapshot.
Traits§
- Debug
Binding Boundary - Render handles into JSON-shaped debug values.
Type Aliases§
- Describe
Sink - Sink type for reactive describe.
- Node
Factory - Factory for auto-hydration mode. D246: receives the embedder’s
&Core+ the Core-freeGraphhandle. - Snapshot
Builder - Builder function for
Graph::from_snapshotbuilder mode (D246:&Core+ Core-freeGraph).