vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

JoinReadWrite: Minor docs improvements.

This commit is contained in:
Ian Jackson 2023-04-06 11:02:27 +01:00
parent fbf1a6d8d4
commit 4bf42c951c
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/tor-async-utils/src/join_read_write.rs
View File

@ -10,11 +10,10 @@ use pin_project::pin_project;
/// Async readable/writeable that dispatches reads to `R` and writes to `W`
///
/// `AsyncRead` is forwarded to `R`.
///
/// `AsyncWrite` is forwarded to `W`.
///
/// This is the converse of
/// [`AsyncReadExt::split`](futures::AsyncReadExt::split).
/// [`JoinReadWrite::new()`] is the converse of
/// [`AsyncReadExt::split()`](futures::AsyncReadExt::split).
/// But, if `R` and `W` came from splitting a single `AsyncRead + AsyncWrite`,
/// you probably want the `reunite` or `unsplit` method, instead of `JoinReadWrite`.
///