summaryrefslogtreecommitdiffstats
path: root/tokio/src/sync/mpsc/unbounded.rs
diff options
context:
space:
mode:
authorZephyr Shannon <geoffpshannon@gmail.com>2020-09-09 13:28:28 -0700
committerGitHub <noreply@github.com>2020-09-09 22:28:28 +0200
commitbe7462e50fe21c3eea578e12765f501e1157072b (patch)
tree8df08507165561c4f0b47fd8ca09b47b980b429b /tokio/src/sync/mpsc/unbounded.rs
parent1550dda5cfba0f9f38ec5550fc3c488b9d462ae4 (diff)
sync: document mpsc::bounded minimum buffer size (#2808)
Diffstat (limited to 'tokio/src/sync/mpsc/unbounded.rs')
-rw-r--r--tokio/src/sync/mpsc/unbounded.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/tokio/src/sync/mpsc/unbounded.rs b/tokio/src/sync/mpsc/unbounded.rs
index 1b2288ab..6b2ca722 100644
--- a/tokio/src/sync/mpsc/unbounded.rs
+++ b/tokio/src/sync/mpsc/unbounded.rs
@@ -47,7 +47,7 @@ impl<T> fmt::Debug for UnboundedReceiver<T> {
}
/// Creates an unbounded mpsc channel for communicating between asynchronous
-/// tasks.
+/// tasks without backpressure.
///
/// A `send` on this channel will always succeed as long as the receive half has
/// not been closed. If the receiver falls behind, messages will be arbitrarily