Struct DataWriter

pub struct DataWriter { /* private fields */ }

The write half of a DataStream, implementing futures::io::AsyncWrite.

See the DataStream docs for more information. In particular, note that this writer requires poll_flush to complete in order to guarantee that all data has been written.

Usage with Tokio

If the tokio crate feature is enabled, this type also implements tokio::io::AsyncWrite for easier integration with code that expects that trait.

Drop and close

Note that dropping a DataWriter has no special effect on its own: if the DataWriter is dropped, the underlying stream will still remain open until the DataReader is also dropped.

If you want the stream to close earlier, use close (or shutdown with tokio).

Remember that Tor does not support half-open streams: If you close or shutdown a stream, the other side will not see the stream as half-open, and so will (probably) not finish sending you any in-progress data. Do not use close/shutdown to communicate anything besides “I am done using this stream.”

Implementations

impl DataWriter

pub fn ctrl(&self) -> &Arc<DataStreamCtrl>

Available on crate feature stream-ctrl only.

Return a DataStreamCtrl object that can be used to monitor and interact with this stream without holding the stream itself.

Trait Implementations

impl AsyncWrite for DataWriter

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

Attempt to write bytes from buf into the object.

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

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

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

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 DataWriter

Available on crate feature tokio only.

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

Attempt to write bytes from buf into the object.

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

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

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

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 DataWriter

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

Formats the value using the given formatter.