Struct RecvStream 

pub struct RecvStream<T> { /* private fields */ }

A stream of messages from the peer.

On the client, the response messages of a server-streaming or a bidi call. On the server, the request messages of a client-streaming or a bidi call.

Messages are read with recv() or as a Stream. The stream ends with None once the peer ends it, or with an error. The messages received before an error are read first.

A decoding error discards the remaining buffered data and releases its flow-control capacity.

The client reports the status of the call as StreamError::Client. Dropping the stream on the client before its end cancels the call.

Implementations

impl<T> RecvStream<T>

pub fn headers(&self) -> &HeaderMap

The headers of the peer.

On the client, the response headers, available once the first message or the end of the stream is received. On the server, the request headers.

pub fn trailers(&self) -> &HeaderMap

The trailers of the peer, available once the stream has ended.

pub fn status(&self) -> Option<GrpcStatus>

The status the stream ended with, None until it has ended.

impl<T: Message> RecvStream<T>

pub fn poll_recv( &mut self, cx: &mut Context<'_>, ) -> Poll<Option<Result<T, StreamError>>>

Polls for the next message.

Returns None once the peer has ended the stream. After an error the stream returns None.

pub async fn recv(&mut self) -> Option<Result<T, StreamError>>

Receives the next message, None once the peer has ended the stream.

Trait Implementations

impl<T> Debug for RecvStream<T>

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

Formats the value using the given formatter.

impl<T> Drop for RecvStream<T>

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.

impl<T: Message> Stream for RecvStream<T>

type Item = Result<T, StreamError>

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.