Struct SendStream

pub struct SendStream { /* private fields */ }

A stream that can be used to send bytes. See quinn::SendStream.

This wrapper is mainly needed for error codes, which is unfortunate. WebTransport uses u32 error codes and they’re mapped in a reserved HTTP/3 error space.

Implementations

impl SendStream

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

Abruptly reset the stream with the provided error code. See quinn::SendStream::reset. This is a u32 with WebTransport because we share the error space with HTTP/3.

pub async fn stopped(&mut self) -> Result<Option<u32>, StoppedError>

Wait until the stream has been stopped and return the error code. See quinn::SendStream::stopped. Unlike Quinn, this returns None if the code is not a valid WebTransport error code.

pub async fn write(&mut self, buf: &[u8]) -> Result<usize, WriteError>

Write some data to the stream, returning the size written. See quinn::SendStream::write.

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

Write all of the data to the stream. See quinn::SendStream::write_all.

pub async fn write_chunks( &mut self, bufs: &mut [Bytes], ) -> Result<Written, WriteError>

Write chunks of data to the stream. See quinn::SendStream::write_chunks.

pub async fn write_chunk(&mut self, buf: Bytes) -> Result<(), WriteError>

Write a chunk of data to the stream. See quinn::SendStream::write_chunk.

pub async fn write_all_chunks( &mut self, bufs: &mut [Bytes], ) -> Result<(), WriteError>

Write all of the chunks of data to the stream. See quinn::SendStream::write_all_chunks.

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

Wait until all of the data has been written to the stream. See quinn::SendStream::finish.

pub fn set_priority(&self, order: i32) -> Result<(), ClosedStream>

pub fn priority(&self) -> Result<i32, ClosedStream>

Trait Implementations

impl AsyncWrite for SendStream

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

Attempt to write bytes from buf into the object.

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

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

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

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 Debug for SendStream

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

Formats the value using the given formatter.