Struct ChangeEventStream 

pub struct ChangeEventStream { /* private fields */ }

Async stream wrapper for push subscriptions.

Implements Stream<Item = ChangeEvent>, silently skipping lagged events (with a tracing::debug! log). The stream terminates when the source is closed or the subscription is cancelled.

All fields are Unpin (including BroadcastStream), so the struct is Unpin and works directly with tokio::select! without explicit pinning.

Dropping the stream automatically cancels the subscription in the registry.

Implementations

impl ChangeEventStream

pub fn id(&self) -> SubscriptionId

Returns the subscription ID.

pub fn query(&self) -> &str

Returns the query or source name for this subscription.

pub fn is_terminated(&self) -> bool

Returns true if the stream has terminated.

pub fn pause(&self) -> bool

Pauses the underlying subscription.

While paused, events are buffered or dropped per the backpressure configuration. Returns true if the subscription was active and is now paused.

pub fn resume(&self) -> bool

Resumes the underlying subscription.

Returns true if the subscription was paused and is now active.

pub fn cancel(&mut self)

Cancels the subscription and terminates the stream.

Subsequent calls to poll_next / next() return None.

pub fn metrics(&self) -> Option<SubscriptionMetrics>

Returns subscription metrics from the registry.

Trait Implementations

impl Drop for ChangeEventStream

fn drop(&mut self)

Executes the destructor for this type.

impl Stream for ChangeEventStream

type Item = ChangeEvent

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.