Struct RecvStream 

pub struct RecvStream { /* private fields */ }

A stream that can be used to receive bytes. See quinn::RecvStream.

Implementations

impl RecvStream

pub fn stop(&mut self, code: u32) -> Result<(), ClosedStream>

Tell the peer to stop sending data with the given error code. See quinn::RecvStream::stop. WebTransport uses a u32 because it shares the error space with HTTP/3.

pub async fn read(&mut self, buf: &mut [u8]) -> Result<Option<usize>, ReadError>

Read some data into the buffer and return the amount read. See quinn::RecvStream::read.

pub async fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), ReadExactError>

Fill the entire buffer with data. See quinn::RecvStream::read_exact.

pub async fn read_chunk( &mut self, max_length: usize, ordered: bool, ) -> Result<Option<Chunk>, ReadError>

Read a chunk of data from the stream. See quinn::RecvStream::read_chunk.

pub async fn read_chunks( &mut self, bufs: &mut [Bytes], ) -> Result<Option<usize>, ReadError>

Read chunks of data from the stream. See quinn::RecvStream::read_chunks.

pub async fn read_to_end( &mut self, size_limit: usize, ) -> Result<Vec<u8>, ReadToEndError>

Read until the end of the stream or the limit is hit. See quinn::RecvStream::read_to_end.

pub async fn received_reset(&mut self) -> Result<Option<u32>, SessionError>

Block until the stream has been reset and return the error code. See quinn::RecvStream::received_reset.

Unlike Quinn, this returns SessionError (not ResetError) because 0-RTT is not supported.

pub fn quic_id(&self) -> StreamId

Return the underlying QUIC stream ID.

Warning

WebTransport sessions share the QUIC connection with HTTP/3 and other sessions. The quinn::StreamId::index may not increment by 1 as it does in a standalone quinn connection. The JavaScript WebTransport API therefore does not expose stream IDs.

Trait Implementations

impl AsyncRead for RecvStream

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

Attempts to read from the AsyncRead into buf.

impl Debug for RecvStream

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

Formats the value using the given formatter.

impl RecvStream for RecvStream

type Error = ReadError

Error type returned by receive-side stream operations.

fn stop(&mut self, code: u32)

Send a STOP_SENDING QUIC code, informing the peer that no more data will be read.

async fn read(&mut self, dst: &mut [u8]) -> Result<Option<usize>, Self::Error>

Read the next chunk of data, up to the max size.

async fn read_chunk(&mut self, max: usize) -> Result<Option<Bytes>, Self::Error>

Read the next chunk of data, up to the max size.

async fn closed(&mut self) -> Result<(), Self::Error>

Block until the stream has been closed by either side.

fn read_buf<B>( &mut self, buf: &mut B, ) -> impl Future<Output = Result<Option<usize>, Self::Error>> + MaybeSend

where B: BufMut + MaybeSend,

Read some data into the provided buffer.

fn read_all( &mut self, ) -> impl Future<Output = Result<Bytes, Self::Error>> + MaybeSend

Helper to keep reading until the stream is closed.

fn read_all_buf<B>( &mut self, buf: &mut B, ) -> impl Future<Output = Result<usize, Self::Error>> + MaybeSend

where B: BufMut + MaybeSend,

Helper to keep reading until the buffer is full.