[][src]Struct h2::RecvStream

#[must_use = "streams do nothing unless polled"]
pub struct RecvStream { /* fields omitted */ }

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.0 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 ReleaseCapacity for more details on inbound flow control.

Note that this type implements Stream, yielding the received data frames. When this implementation is used, the capacity is immediately released when the data is yielded. It is recommended to only use this API when the data will not be retained in memory for extended periods of time.

Methods

impl RecvStream[src]

pub fn is_end_stream(&self) -> bool[src]

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 release_capacity(&mut self) -> &mut ReleaseCapacity[src]

Get a mutable reference to this streams ReleaseCapacity.

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

pub fn poll_trailers(&mut self) -> Poll<Option<HeaderMap>, Error>[src]

Returns received trailers.

pub fn stream_id(&self) -> StreamId[src]

Returns the stream ID of this stream.

Panics

If the lock on the stream store has been poisoned.

Trait Implementations

impl Drop for RecvStream[src]

impl Debug for RecvStream[src]

impl Stream for RecvStream[src]

type Item = Bytes

The type of item this stream will yield on success.

type Error = Error

The type of error this stream may generate.

Auto Trait Implementations

impl Send for RecvStream

impl Unpin for RecvStream

impl Sync for RecvStream

impl UnwindSafe for RecvStream

impl RefUnwindSafe for RecvStream

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]