Skip to content

Commit

Permalink
Future proofed exception paragraph in runtime compatibility section
Browse files Browse the repository at this point in the history
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
  • Loading branch information
jofas and Darksonn authored Sep 10, 2024
1 parent d8dee34 commit afbf8c8
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions tokio/src/sync/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -442,10 +442,9 @@
//! [cooperative scheduling](crate::task#cooperative-scheduling) to avoid
//! starvation. This feature does not apply when used from non-Tokio runtimes.
//!
//! The only exception to runtime compatibility is the
//! [`mpsc::Sender::send_timeout`] method, which can't be called from non-Tokio
//! runtimes. However, [`Senders`](mpsc::Sender) can still be moved between
//! different instances of the Tokio runtime.
//! As an exception, methods ending in `_timeout` are not runtime agnostic
//! because they require access to the Tokio timer. See the documentation of
//! each `*_timeout` method for more information on its use.

cfg_sync! {
/// Named future types.
Expand Down

0 comments on commit afbf8c8

Please sign in to comment.