Struct s2n_quic_transport::stream::SendStream

pub struct SendStream(_);

A writeable QUIC stream

Implementations

impl SendStream

pub fn id(&self) -> StreamId

pub fn connection(&self) -> &Connection

pub fn tx_request(&mut self) -> Result<TxRequest<'_, '_>, StreamError>

pub fn poll_send(
    &mut self,
    chunk: &mut Bytes,
    cx: &mut Context<'_>
) -> Poll<Result<(), StreamError>>

Enqueues a chunk of data for sending it towards the peer.

The method will return:

• Poll::Ready(Ok(())) if the data was enqueued for sending. The provided Bytes will be replaced with an empty Bytes, in order to reduce needless ref count increases.
• Poll::Ready(Err(stream_error)) if the data could not be sent, because the stream had previously entered an error state.
• Poll::Pending if the send buffer capacity is currently exhausted. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn poll_send_vectored(
    &mut self,
    chunks: &mut [Bytes],
    cx: &mut Context<'_>
) -> Poll<Result<usize, StreamError>>

Enqueues a slice of chunks of data for sending it towards the peer.

The method will return:

• Poll::Ready(Ok(count)) if part of the slice was enqueued for sending. Any of the consumed Bytes will be replaced with an empty Bytes, in order to reduce needless ref count increases. If count does not equal the total number of chunks, the stream will store the waker and wake the task once more capacity is available.
• Poll::Ready(Err(stream_error)) if the data could not be sent, because the stream had previously entered an error state.
• Poll::Pending if the send buffer capacity is currently exhausted. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn poll_send_ready(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<usize, StreamError>>

Polls send readiness for the given stream.

The method will return:

• Poll::Ready(Ok(available_bytes)) if the stream is ready to send data, where available_bytes is how many bytes the stream can currently accept.
• Poll::Ready(Err(stream_error)) if the data could not be sent, because the stream had previously entered an error state.
• Poll::Pending if the send buffer capacity is currently exhausted. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn send_data(&mut self, chunk: Bytes) -> Result<(), StreamError>

Enqueues a chunk of data for sending it towards the peer.

This method should only be called after calling poll_send_ready first, as the stream may not have available send buffer capacity.

The method will return:

• Ok(()) if the data was enqueued for sending.
• Err(stream_error) if the data could not be sent, because the stream had previously entered an error state, or the stream was not ready to send data.

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

Flushes the send buffer and waits for acknowledgement from the peer.

The method will return:

• Poll::Ready(Ok(())) if the send buffer was completely flushed and acknowledged.
• Poll::Ready(Err(stream_error)) if the stream could not be flushed, because the stream had previously entered an error state.
• Poll::Pending if the send buffer is still being flushed. In this case, the caller should retry sending after the Waker on the provided Context is notified.

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

Marks the stream as finished.

The method will return:

• Ok(()) if the stream was finished successfully
• Err(stream_error) if the stream could not be finished, because the stream had previously entered an error state.

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

Marks the stream as finished and waits for all outstanding data to be acknowledged

The method will return:

• Poll::Ready(Ok(())) if the stream was completely flushed and acknowledged.
• Poll::Ready(Err(stream_error)) if the stream could not be flushed, because the stream had previously entered an error state.
• Poll::Pending if the stream is still being flushed. In this case, the caller should retry sending after the Waker on the provided Context is notified.

pub fn reset(&mut self, error_code: Error) -> Result<(), StreamError>

Initiates a RESET on the stream.

This will close the stream and notify the peer of the provided error_code.

Trait Implementations

impl Debug for SendStream

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

Formats the value using the given formatter.

impl From<Stream> for SendStream

fn from(stream: Stream) -> Self

Converts to this type from the input type.