Struct TelemetryReader 

pub struct TelemetryReader<T, S> { /* private fields */ }

A single consumer cursor. User code chooses when to read and what to retain.

Implementations

impl<T, S: Copy> TelemetryReader<T, S>

pub fn try_read(&mut self) -> Option<TelemetryRead<'_, T>>

Pulls the oldest retained frame without waiting. At most one borrowed frame can be held through this reader. Frame sequence wraps modulo u64; fewer than 2^64 publications may separate consecutive reads.

pub fn status(&mut self) -> S

Observes/acknowledges coalesced current status independently of frames. A buffered frame may belong to an older session than this status.

pub fn is_closed(&self) -> bool

True after publisher shutdown; any retained frames can still be read.

pub fn overwritten(&self) -> u64

pub fn register_waker(&self, waker: &Waker)

Registers a one-shot payload-free wake. Re-arm before checking data and status. The waker must only schedule/unpark, never process user data. The post-registration readiness check prevents lost wakeups.

pub async fn ready(&mut self)

Waits asynchronously for unread data, changed status, or closure. This is level-triggered: drain data and observe status before waiting again.

pub fn wait_timeout(&mut self, timeout: Duration) -> bool

Synchronous counterpart of ready, with a timeout for UI/input timers. Returns false only on timeout. The first call on a thread allocates its reusable thread waker; publication itself never allocates a notification.

Trait Implementations

impl<T, S> Drop for TelemetryReader<T, S>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.