Skip to main content

GraphObserveOne

Struct GraphObserveOne 

Source
pub struct GraphObserveOne { /* private fields */ }
Expand description

Single-node observe handle (canonical §3.6.2).

D246: holds a Core-free Graph; &Core is passed per call.

§Deliberate divergence from canonical R3.6.2 up(messages) (D280 doc-lock)

Canonical R3.6.2 specifies a unified up(messages: Messages) upstream-injection API. This impl exposes the per-tier control methods Self::pause / Self::resume / Self::invalidate as separate methods rather than a single up(messages) shape. The split is deliberate, on two grounds:

  1. Non-allocating ergonomics. A unified up(Vec<Message>) forces a Vec allocation on every upstream call. The per-tier methods take their args by value and take a direct path into Core::pause / Core::resume / Core::invalidate — zero heap churn on the control plane.

  2. Avoids re-exposing an imperative-shaped public surface. The Rust port’s collaboration directive (feedback_no_imperative user memory) is to expose reactive NodeInput shapes at the public surface, not imperative message-injection. The per-tier methods read as intent-named control calls (pause(lock), resume(lock), invalidate()); a unified up([PAUSE, lock]) re-exposes the protocol-internal Messages shape and tier numbers as call-site vocabulary.

Cross-binding wrappers (napi-rs BenchGraph, future pyo3, etc.) may reassemble a unified up(messages) if a JS/Python idiomatic API needs it; the substrate-side split is the Rust public-surface contract.

§Lift point (only if needed)

If a Rust consumer surfaces a need for a unified up(messages) — e.g., a cross-impl parity scenario authored against the canonical R3.6.2 shape — add it alongside the per-tier methods (additive, non-breaking). Gated on D196 consumer pressure.

Implementations§

Source§

impl GraphObserveOne

Source

pub fn node_id(&self) -> NodeId

The observed NodeId.

Source

pub fn subscribe(&self, core: &Core, sink: Sink) -> ObserveSub

Subscribe a sink. Returns an ObserveSub id pair — detach owner-invoked (D246 rule 3).

Source

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

Send [PAUSE, lock] upstream.

§Errors

See PauseError.

Source

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

Send [RESUME, lock] upstream.

§Errors

See PauseError.

Source

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

Send [INVALIDATE] upstream.

Source

pub fn graph(&self) -> &Graph

The backing graph handle.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.