Struct arti_tor_client::DataStream

pub struct DataStream { /* fields omitted */ }

An anonymized stream over the Tor network.

For most purposes, you can think of this type as an anonymized TCP stream: it can read and write data, and get closed when it’s done.

To get one of these, clients should use TorClient::connect(). DataStream implements [futures::io::AsyncRead] and [futures::io::AsyncWrite], so you can use it anywhere that those types are expected.

This type is a re-export from tor_proto::stream::DataStream; see that crate for its documentation in a more low-level context. A DataStream is a Tor stream packaged so as to be useful for byte-oriented IO.

It’s suitable for use with BEGIN or BEGIN_DIR streams.

Semver note:

Note that this type is re-exported as a part of the public API of the tor-client crate. Any changes to its API here in tor-proto need to be reflected above.

Implementations

impl DataStream

An anonymized stream over the Tor network.

For most purposes, you can think of this type as an anonymized TCP stream: it can read and write data, and get closed when it’s done.

To get one of these, clients should use TorClient::connect(). DataStream implements [futures::io::AsyncRead] and [futures::io::AsyncWrite], so you can use it anywhere that those types are expected.

This type is a re-export from tor_proto::stream::DataStream; see that crate for its documentation in a more low-level context.

pub fn split(self) -> (DataReader, DataWriter)

Divide this DataStream into its consituent parts.

Trait Implementations

impl AsyncRead for DataStream

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

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for DataStream

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

Attempt to write bytes from buf into the object.

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

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

pub fn poll_close(
    self: Pin<&mut DataStream>,
    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.