Struct h2::share::RecvStream

pub struct RecvStream {
    inner: FlowControl,
}

Receives the body stream and trailers from the remote peer.

A RecvStream is provided by client::ResponseFuture and server::Connection with the received HTTP/2 message head (the response and request head respectively).

A RecvStream instance is used to receive the streaming message body and any trailers from the remote peer. It is also used to manage inbound flow control.

See method level documentation for more details on receiving data. See FlowControl for more details on inbound flow control.

Fields

inner: FlowControl

Implementations

impl RecvStream

pub(crate) fn new(inner: FlowControl) -> Self

pub async fn data(&mut self) -> Option<Result<Bytes, Error>>

Get the next data frame.

pub async fn trailers(&mut self) -> Result<Option<HeaderMap>, Error>

Get optional trailers for this stream.

pub fn poll_data( &mut self, cx: &mut Context<'_> ) -> Poll<Option<Result<Bytes, Error>>>

Poll for the next data frame.

pub fn is_end_stream(&self) -> bool

Returns true if the receive half has reached the end of stream.

A return value of true means that calls to poll and poll_trailers will both return None.

pub fn flow_control(&mut self) -> &mut FlowControl

Get a mutable reference to this stream’s FlowControl.

It can be used immediately, or cloned to be used later.

pub fn stream_id(&self) -> StreamId

Returns the stream ID of this stream.

Panics

If the lock on the stream store has been poisoned.

Trait Implementations

impl Debug for RecvStream

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

Formats the value using the given formatter.

impl Drop for RecvStream

fn drop(&mut self)

Executes the destructor for this type.