Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document that broadcast capacity is lower bound #6042

Merged
merged 2 commits into from Oct 3, 2023
Merged

Document that broadcast capacity is lower bound #6042

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64f3ba5
sync: document broadcast capacity
Darksonn Oct 1, 2023
992bfc2
Update tokio/src/sync/broadcast.rs
Darksonn Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion tokio/src/sync/broadcast.rs
View file
Open in desktop
Expand Up @@ -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.
///
Expand Down Expand Up @@ -474,7 +476,7 @@ unsafe impl<T: Send> Sync for Receiver<T> {}
impl<T> Sender<T> {
/// Creates the sending-half of the [`broadcast`] channel.
///
/// See documentation of [`broadcast::channel`] for errors when calling this function.
/// See documentation of [`broadcast::channel`] for more information on this method.
Darksonn marked this conversation as resolved.
Show resolved Hide resolved
///
/// [`broadcast`]: crate::sync::broadcast
/// [`broadcast::channel`]: crate::sync::broadcast
Expand Down