Struct NotificationStream 

pub struct NotificationStream<'a> { /* private fields */ }

A Stream of SessionNotifications the agent streams to the client.

Returned by AcpStdioPeer::notifications. The stream owns a clone of the peer’s notification-receiver mutex and re-acquires it on every poll; the lock guard is held across Pending polls so another task cannot race in and reorder notifications.

&self (not &mut self) and + '_ so the consumer can hold the peer by Arc and call notifications() from any task without re-entering a &mut self borrow — the same shape recv_notification supports, but as a Stream.

Cancel safety

Stream::poll_next is cancel-safe in the same way Receiver::recv is: a select! that polls this stream and another branch is guaranteed to either return the notification or hand the lock back unchanged, never a partially-consumed channel.

Examples

use futures_util::StreamExt;
let mut stream = peer.notifications();
while let Some(notification) = stream.next().await {
    render(notification);
}

Trait Implementations

impl Debug for NotificationStream<'_>

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

The type only — neither the receiver nor the lock state is worth showing. A Debug for a stream that prints its internal Pin<Box<dyn Future>> would format the future’s internal waker and pointer, which is a leak of the executor’s representation into a log line that should be the consumer’s view of the stream.

impl Stream for NotificationStream<'_>

type Item = SessionNotification

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.