]> git.feebdaed.xyz Git - 0xmirror/tokio.git/commitdiff
time: update outdated docs of `Wheel` (#7749)
authorMattia Pitossi <mattiapitossi@gmail.com>
Sat, 29 Nov 2025 10:06:33 +0000 (11:06 +0100)
committerGitHub <noreply@github.com>
Sat, 29 Nov 2025 10:06:33 +0000 (18:06 +0800)
tokio-util/src/time/wheel/mod.rs
tokio/src/runtime/time/wheel/mod.rs
tokio/src/runtime/time_alt/wheel/mod.rs

index 2ad70a97c727dca33de8bbdcb768ec0026c85cf5..f310d10c113ed525838ade4a585cf49e2e19743d 100644 (file)
@@ -10,15 +10,17 @@ use std::fmt::Debug;
 
 /// Timing wheel implementation.
 ///
-/// This type provides the hashed timing wheel implementation that backs `Timer`
-/// and `DelayQueue`.
+/// This type provides the hashed timing wheel implementation that backs
+/// [`DelayQueue`].
 ///
 /// The structure is generic over `T: Stack`. This allows handling timeout data
 /// being stored on the heap or in a slab. In order to support the latter case,
 /// the slab must be passed into each function allowing the implementation to
 /// lookup timer entries.
 ///
-/// See `Timer` documentation for some implementation notes.
+/// See `Driver` documentation for some implementation notes.
+///
+/// [`DelayQueue`]: crate::time::DelayQueue
 #[derive(Debug)]
 pub(crate) struct Wheel<T> {
     /// The number of milliseconds elapsed since the wheel started.
index 89adc8f2dcb05f2fd54fa9ea36ee44ab98e468cc..c0c51ef7447d410051454f51999cb98e23b8dbe0 100644 (file)
@@ -12,15 +12,12 @@ use super::EntryList;
 
 /// Timing wheel implementation.
 ///
-/// This type provides the hashed timing wheel implementation that backs `Timer`
-/// and `DelayQueue`.
+/// This type provides the hashed timing wheel implementation that backs
+/// [`Driver`].
 ///
-/// The structure is generic over `T: Stack`. This allows handling timeout data
-/// being stored on the heap or in a slab. In order to support the latter case,
-/// the slab must be passed into each function allowing the implementation to
-/// lookup timer entries.
+/// See [`Driver`] documentation for some implementation notes.
 ///
-/// See `Timer` documentation for some implementation notes.
+/// [`Driver`]: crate::runtime::time::Driver
 #[derive(Debug)]
 pub(crate) struct Wheel {
     /// The number of milliseconds elapsed since the wheel started.
index f66a91c150c035b87d019ce19851298b73c1e526..e7699457b74ea4dd4604d67a681ac2e2232c486f 100644 (file)
@@ -7,17 +7,11 @@ use super::{EntryHandle, EntryList, WakeQueue};
 
 use std::array;
 
-/// Timing wheel implementation.
+/// Hashed timing wheel implementation.
 ///
-/// This type provides the hashed timing wheel implementation that backs `Timer`
-/// and `DelayQueue`.
+/// See [`Driver`] documentation for some implementation notes.
 ///
-/// The structure is generic over `T: Stack`. This allows handling timeout data
-/// being stored on the heap or in a slab. In order to support the latter case,
-/// the slab must be passed into each function allowing the implementation to
-/// lookup timer entries.
-///
-/// See `Timer` documentation for some implementation notes.
+/// [`Driver`]: crate::runtime::time::Driver
 #[derive(Debug)]
 pub(crate) struct Wheel {
     /// The number of milliseconds elapsed since the wheel started.