From eaba9712e8a4b35a1a2cdeb3b27845d6239c12ea Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Tue, 3 Oct 2023 09:58:34 +0200 Subject: [PATCH] sync: document that broadcast capacity is a lower bound (#6042) --- tokio/src/sync/broadcast.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tokio/src/sync/broadcast.rs b/tokio/src/sync/broadcast.rs index 42cde81dc9b..9618f2be310 100644 --- a/tokio/src/sync/broadcast.rs +++ b/tokio/src/sync/broadcast.rs @@ -407,6 +407,8 @@ const MAX_RECEIVERS: usize = usize::MAX >> 2; /// Create a bounded, multi-producer, multi-consumer channel where each sent /// value is broadcasted to all active receivers. /// +/// **Note:** The actual capacity may be greater than the provided `capacity`. +/// /// All data sent on [`Sender`] will become available on every active /// [`Receiver`] in the same order as it was sent. /// @@ -474,7 +476,7 @@ unsafe impl Sync for Receiver {} impl Sender { /// Creates the sending-half of the [`broadcast`] channel. /// - /// See documentation of [`broadcast::channel`] for errors when calling this function. + /// See the documentation of [`broadcast::channel`] for more information on this method. /// /// [`broadcast`]: crate::sync::broadcast /// [`broadcast::channel`]: crate::sync::broadcast