Struct quinn::generic::SendStream

pub struct SendStream<S> where
    S: Session,  { /* fields omitted */ }

A stream that can only be used to send data

If dropped, streams that haven’t been explicitly reset() will continue to (re)transmit previously written data until it has been fully acknowledged or the connection is closed.

Implementations

impl<S> SendStream<S> where
    S: Session, 

pub fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, S>

Write bytes to the stream

Yields the number of bytes written on success. Congestion and flow control may cause this to be shorter than buf.len(), indicating that only a prefix of buf was written.

pub fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, S>

Convenience method to write an entire buffer to the stream

pub fn write_chunks<'a>(
    &'a mut self,
    bufs: &'a mut [Bytes]
) -> WriteChunks<'a, S>

Write chunks to the stream

Yields the number of bytes and chunks written on success. Congestion and flow control may cause this to be shorter than buf.len(), indicating that only a prefix of bufs was written

pub fn write_chunk(&mut self, buf: Bytes) -> WriteChunk<'_, S>

Convenience method to write a single chunk in its entirety to the stream

pub fn write_all_chunks<'a>(
    &'a mut self,
    bufs: &'a mut [Bytes]
) -> WriteAllChunks<'a, S>

Convenience method to write an entire list of chunks to the stream

pub fn finish(&mut self) -> Finish<'_, S>

Shut down the send stream gracefully.

No new data may be written after calling this method. Completes when the peer has acknowledged all sent data, retransmitting data as needed.

pub fn reset(&mut self, error_code: VarInt) -> Result<(), UnknownStream>

Close the send stream immediately.

No new data can be written after calling this method. Locally buffered data is dropped, and previously transmitted data will no longer be retransmitted if lost. If an attempt has already been made to finish the stream, the peer may still receive all written data.

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

Set the priority of the send stream

Every send stream has an initial priority of 0. Locally buffered data from streams with higher priority will be transmitted before data from streams with lower priority. Changing the priority of a stream with pending data may only take effect after that data has been transmitted. Using many different priority levels per connection may have a negative impact on performance.

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

Get the priority of the send stream

pub fn stopped(&mut self) -> Stopped<'_, S>

Completes if/when the peer stops the stream, yielding the error code

pub fn id(&self) -> StreamId

Get the identity of this stream

Trait Implementations

impl<S> AsyncWrite for SendStream<S> where
    S: Session, 

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.

pub 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> AsyncWrite for SendStream<S> where
    S: Session, 

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.

pub 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.

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<S: Debug> Debug for SendStream<S> where
    S: Session, 

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

Formats the value using the given formatter.

impl<S> Drop for SendStream<S> where
    S: Session, 

fn drop(&mut self)

Executes the destructor for this type.