Struct WebTransportBidiStream

pub struct WebTransportBidiStream { /* private fields */ }

Available on (crate features http1 or http2 or http3) and crate feature http3 and crate feature webtransport only.

A bidirectional WebTransport stream.

Implementations

impl WebTransportBidiStream

pub fn into_inner(self) -> BidiStream<BidiStream<Bytes>, Bytes>

Get the inner h3_webtransport::stream::BidiStream.

Can be used to access lower-level functionality.

pub fn split(self) -> (WebTransportSendStream, WebTransportRecvStream)

Split this stream into separate send and receive halves.

Example

let (mut send, mut recv) = bidi_stream.split();
tokio::spawn(async move {
    while let Ok(Some(data)) = recv.read().await {
        println!("Received: {:?}", data);
    }
});
send.write(Bytes::from("Hello")).await?;

pub async fn read(&mut self) -> Result<Option<Bytes>, StreamErrorIncoming>

Read data from the receive side of the stream.

pub async fn read_to_end(&mut self, max_size: usize) -> Result<Bytes, Error>

Read all remaining data from the receive side until the stream is finished.

This collects all chunks into a single Bytes object.

Returns an io::Error if the total size exceeds max_size or any read call errors.

Example

let data = bidi_stream.read_to_end(1024 * 1024).await?; // max 1MB

pub async fn write(&mut self, data: Bytes) -> Result<(), StreamErrorIncoming>

Write data to the send side of the stream.

pub async fn finish(&mut self) -> Result<(), StreamErrorIncoming>

Finish writing to the stream.

Trait Implementations

impl Debug for WebTransportBidiStream

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

Formats the value using the given formatter.