Skip to content

time: doc a missing panic scenario of time::advance #7394

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

Merged
merged 2 commits into from
Jun 18, 2025
Merged

time: doc a missing panic scenario of time::advance #7394

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ec749a
time: doc a missing panic scenario of `time::advance`
ADD-SP Jun 7, 2025
951794b
merge: sync changes from the base
ADD-SP Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions tokio/src/time/clock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,18 @@ cfg_test_util! {
///
/// # Panics
///
/// Panics if time is not frozen or if called from outside of the Tokio
/// runtime.
/// Panics if any of the following conditions are met:
///
/// - The clock is not frozen, which means that you must
/// call [`pause`] before calling this method.
/// - If called outside of the Tokio runtime.
/// - If the input `duration` is too large (such as [`Duration::MAX`])
/// to be safely added to the current time without causing an overflow.
///
/// # Caveats
///
/// Using a very large `duration` is not recommended,
/// as it may cause panicking due to overflow.
///
/// # Auto-advance
///
Expand Down