Add a little documentation about when you'll need the tokio trait.

This commit is contained in:
Nick Mathewson 2021-10-19 15:48:55 -04:00
parent f5a7916717
commit a9a9f70eb9
1 changed files with 7 additions and 0 deletions

View File

@ -27,6 +27,13 @@ use tor_cell::relaycell::msg::{Data, RelayMsg};
///
/// It's suitable for use with BEGIN or BEGIN_DIR streams.
///
/// # Note for tokio users
///
/// By default, this type implements only the versions of `AsyncRead`
/// and `AsyncWrite` traits from the [`futures`] crate. If you need
/// it to implement the `tokio` versions of those traits, make sure
/// this crate is built with the `tokio` feature.
///
/// # Semver note:
///
/// Note that this type is re-exported as a part of the public API of