Struct DataWriterInner

struct DataWriterInner {
    state: Option<DataWriterState>,
    _memquota: StreamAccount,
    ctrl: Arc<ClientDataStreamCtrl>,
}

The inner writer for DataWriter.

This type is responsible for taking bytes and packaging them into cells. Rate limiting is implemented in DataWriter to avoid making this type more complex.

Fields

state: Option<DataWriterState>

Internal state for this writer

This is stored in an Option so that we can mutate it in the AsyncWrite functions. It might be possible to do better here, and we should refactor if so.

_memquota: StreamAccount

The memory quota account that should be used for this stream’s data

Exists to keep the account alive

ctrl: Arc<ClientDataStreamCtrl>

Available on crate feature stream-ctrl only.

A control object that can be used to monitor and control this stream without needing to own it.

Implementations

impl DataWriterInner

fn client_stream_ctrl(&self) -> &Arc<ClientDataStreamCtrl>

Available on crate feature stream-ctrl only.

See DataWriter::client_stream_ctrl.

fn poll_flush_impl( self: Pin<&mut Self>, cx: &mut Context<'_>, should_close: bool, ) -> Poll<IoResult<()>>

Helper for poll_flush() and poll_close(): Performs a flush, then closes the stream if should_close is true.

Trait Implementations

impl AsyncWrite for DataWriterInner

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

Attempt to write bytes from buf into the object.

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

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

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

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 AsyncWrite for DataWriterInner

Available on crate feature tokio only.

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

Attempt to write bytes from buf into the object.

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

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

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

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 DataWriterInner

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

Formats the value using the given formatter.