Struct ResponseStream 

pub struct ResponseStream<Resp> { /* private fields */ }

A handle for receiving inbound response items from a streaming RPC.

Typically, you receive a ResponseStream as the result of initiating a streaming RPC. Unlike RequestSender, ResponseStream cannot be cloned and represents exclusive ownership of the inbound stream. Call next to consume incoming messages sequentially. Dropping the ResponseStream cancels the stream.

Enable the unstable-stream feature to convert this type into a Stream via into_stream.

Examples

while let Some(item) = stream.next().await {
    let item = item?;
    println!("Received: {item}");
}

Implementations

impl<Resp> ResponseStream<Resp>

pub async fn next(&mut self) -> Option<Result<Resp, Error>>

Receives the next response message from the stream, or None if the stream has finished.

Returns Some(Err(e)) if a transport, server status, or deserialization error occurs. Once an error or stream completion is reached, subsequent calls return None.

Examples

while let Some(item) = stream.next().await {
    let item = item?;
    println!("Received: {item}");
}

pub fn into_stream( self, ) -> impl Stream<Item = Result<Resp, Error>> + Send + Unpin

Available on crate feature unstable-stream only.

Converts the ResponseStream into an asynchronous Stream.

Examples

let mut stream = stream.into_stream();
while let Some(item) = stream.next().await {
    let item = item?;
    println!("Received: {item}");
}

Trait Implementations

impl<Resp> Debug for ResponseStream<Resp>

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

Formats the value using the given formatter.

impl<Resp> From<Receiver<Result<Resp, Error>>> for ResponseStream<Resp>

where Resp: Send + 'static,

Creates a ResponseStream from a Tokio mpsc::Receiver, useful for mocking in tests.

Examples

let (tx, rx) = mpsc::channel::<Result<String>>(16);
let receiver = ResponseStream::from(rx);

fn from(rx: Receiver<Result<Resp>>) -> Self

Converts to this type from the input type.