Struct s2n_quic_transport::stream::ReceiveStream

pub struct ReceiveStream(/* private fields */);

A readable QUIC stream

Implementations

impl ReceiveStream

pub fn id(&self) -> StreamId

pub fn connection(&self) -> &Connection

pub fn rx_request(&mut self) -> Result<RxRequest<'_, '_>, StreamError>

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

Receives a chunk of data from the stream.

The method will return:

• Poll::Ready(Ok(Some(chunk))) if the stream is open and data was available
• Poll::Ready(Ok(None)) if the stream was finished and all of the data was consumed
• Poll::Ready(Err(stream_error)) if the stream could not be read, because the stream had previously entered an error state.
• Poll::Pending if the stream is waiting to receive data from the peer. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn poll_receive_vectored( &mut self, chunks: &mut [Bytes], cx: &mut Context<'_> ) -> Poll<Result<(usize, bool), StreamError>>

Receives a slice of chunks of data from the stream.

The method will return:

• Poll::Ready(Ok((len, is_open))) if the stream received data into the slice, where len was the number of chunks received, and is_open indicating if the stream is still open. If is_open == false, future calls to poll_receive_vectored will always return Poll::Ready(Ok((0, false))).
• Poll::Ready(Err(stream_error)) if the stream could not be read, because the stream had previously entered an error state.
• Poll::Pending if the stream is waiting to receive data from the peer. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn stop_sending(&mut self, error_code: Error) -> Result<(), StreamError>

Sends a STOP_SENDING message to the peer. This requests the peer to finish the Stream as soon as possible by issuing a RESET with the provided error_code.

Since this is merely a request to the peer to RESET the Stream, the Stream will not immediately be in a RESET state after issuing this API call.

If the Stream had been previously reset by the peer or if all data had already been received the API call will not trigger any action.

Trait Implementations

impl Debug for ReceiveStream

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

Formats the value using the given formatter.

impl From<Stream> for ReceiveStream

fn from(stream: Stream) -> Self

Converts to this type from the input type.