Struct BufRecvStream

pub struct BufRecvStream<S, B> { /* private fields */ }

Available on crate feature h3 only.

A stream which allows partial reading of the data without data loss.

This fixes the problem where poll_data returns more than the needed amount of bytes, requiring correct implementations to hold on to that extra data and return it later.

Usage

Implements quic::RecvStream which will first return buffered data, and then read from the stream

Implementations

impl<S, B> BufRecvStream<S, B>

pub fn new(stream: S) -> BufRecvStream<S, B>

impl<B, S> BufRecvStream<S, B>

where S: RecvStream,

pub fn poll_read( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<bool, StreamErrorIncoming>>

Reads more data into the buffer, returning the number of bytes read.

Returns true if the end of the stream is reached.

pub fn take_chunk(&mut self, limit: usize) -> Option<Bytes>

Returns the next chunk of data from the stream

Return None when there is no more buffered data; use Self::poll_read.

pub fn has_remaining(&mut self) -> bool

Returns true if there is remaining buffered data

pub fn is_eos(&self) -> bool

Trait Implementations

impl<S, B> AsyncRead for BufRecvStream<S, B>

where B: Buf, S: RecvStream,

fn poll_read( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<S, B> AsyncRead for BufRecvStream<S, B>

where B: Buf, S: RecvStream,

fn poll_read( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<(), Error>>

Attempts to read from the AsyncRead into buf.

impl<S, B> AsyncWrite for BufRecvStream<S, B>

where B: Buf, S: SendStreamUnframed<B>,

fn poll_write( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut BufRecvStream<S, B>>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S, B> AsyncWrite for BufRecvStream<S, B>

where B: Buf, S: SendStreamUnframed<B>,

fn poll_write( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut BufRecvStream<S, B>>, _: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut BufRecvStream<S, B>>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<S, B> BidiStream<B> for BufRecvStream<S, B>

where B: Buf, S: BidiStream<B>,

type SendStream = BufRecvStream<<S as BidiStream<B>>::SendStream, B>

The type for the send half.

type RecvStream = BufRecvStream<<S as BidiStream<B>>::RecvStream, B>

The type for the receive half.

fn split( self, ) -> (<BufRecvStream<S, B> as BidiStream<B>>::SendStream, <BufRecvStream<S, B> as BidiStream<B>>::RecvStream)

Split this stream into two halves.

impl<S, B> Debug for BufRecvStream<S, B>

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

Formats the value using the given formatter.

impl<S, B> RecvStream for BufRecvStream<S, B>

where S: RecvStream,

type Buf = Bytes

The type of Buf for data received on this stream.

fn poll_data( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Option<<BufRecvStream<S, B> as RecvStream>::Buf>, StreamErrorIncoming>>

Poll the stream for more data.

fn stop_sending(&mut self, error_code: u64)

Send a STOP_SENDING QUIC code.

fn recv_id(&self) -> StreamId

Get QUIC send stream id

impl<S, B> SendStream<B> for BufRecvStream<S, B>

where B: Buf, S: SendStream<B>,

fn poll_finish( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), StreamErrorIncoming>>

Poll to finish the sending side of the stream.

fn reset(&mut self, reset_code: u64)

Send a QUIC reset code.

fn send_id(&self) -> StreamId

Get QUIC send stream id

fn poll_ready( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), StreamErrorIncoming>>

Polls if the stream can send more data.

fn send_data<T>(&mut self, data: T) -> Result<(), StreamErrorIncoming>

where T: Into<WriteBuf<B>>,

Send more data on the stream.

impl<S, B> SendStreamUnframed<B> for BufRecvStream<S, B>

where B: Buf, S: SendStreamUnframed<B>,

fn poll_send<D>( &mut self, cx: &mut Context<'_>, buf: &mut D, ) -> Poll<Result<usize, StreamErrorIncoming>>

where D: Buf,

Attempts to write data into the stream.

impl<'__pin, S, B> Unpin for BufRecvStream<S, B>

where <PinnedFieldsOfHelperStruct<__Origin<'__pin, S, B>> as PinnedFieldsOfHelperTrait>::Actual: Unpin,