Struct SendStream 

pub struct SendStream { /* private fields */ }

A byte stream sent to the remote peer.

Implementations

impl SendStream

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

Write all of the provided bytes to the stream.

pub async fn write_buf<B: Buf>(&mut self, buf: &mut B) -> Result<usize, Error>

Write some of the provided buffer to the stream.

pub fn reset(&mut self, reason: &str)

Send an immediate reset, closing the stream with an error.

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

Mark the stream as finished.

This is called on drop, but can also be invoked manually.

pub fn set_priority(&mut self, priority: i32) -> Result<(), Error>

Set the stream’s priority.

Streams with higher values are sent first, but delivery order is not guaranteed.

pub async fn closed(&self) -> Result<Option<u8>, Error>

Block until the stream has closed and return the error code, if any.

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<()>>

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

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

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

fn drop(&mut self)

Close the stream with a FIN.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl SendStream for SendStream

Available on target_family=wasm only.

type Error = Error

Error type returned by send-side stream operations.

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

Write some of the buffer to the stream.

fn set_priority(&mut self, order: u8)

Set the stream’s priority.

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

Mark the stream as finished, erroring on any future writes.

fn reset(&mut self, code: u32)

Immediately close the stream and discard any remaining data.

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

Block until the stream is closed by either side.

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

where B: Buf + MaybeSend,

Write the given buffer to the stream, advancing the internal position.

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

Write the entire Bytes chunk to the stream, potentially avoiding a copy.

fn write_all( &mut self, buf: &[u8], ) -> impl Future<Output = Result<(), Self::Error>> + MaybeSend

Helper to write all data in the buffer.

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

where B: Buf + MaybeSend,

Helper to write all data in the buffer.