tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-06 00:00:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

time: update outdated docs of Wheel (#7749)

Browse Source
This commit is contained in:
Mattia Pitossi
2025-11-29 18:06:33 +08:00
committed by GitHub
parent c03a37fa0b
commit ab3996a6dd
3 changed files with 12 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/time/wheel/mod.rs
+5 -3
View File
@@ -10,15 +10,17 @@ use std::fmt::Debug;
/// Timing wheel implementation. /// Timing wheel implementation.
/// ///
/// This type provides the hashed timing wheel implementation that backs `Timer` /// This type provides the hashed timing wheel implementation that backs
/// and `DelayQueue`. /// [`DelayQueue`].
/// ///
/// The structure is generic over `T: Stack`. This allows handling timeout data /// 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, /// 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 /// the slab must be passed into each function allowing the implementation to
/// lookup timer entries. /// lookup timer entries.
/// ///
/// See `Timer` documentation for some implementation notes. /// See `Driver` documentation for some implementation notes.
///
/// [`DelayQueue`]: crate::time::DelayQueue
#[derive(Debug)] #[derive(Debug)]
pub(crate) struct Wheel<T> { pub(crate) struct Wheel<T> {
/// The number of milliseconds elapsed since the wheel started. /// The number of milliseconds elapsed since the wheel started.
tokio/src/runtime/time/wheel/mod.rs
+4 -7
View File
@@ -12,15 +12,12 @@ use super::EntryList;
/// Timing wheel implementation. /// Timing wheel implementation.
/// ///
/// This type provides the hashed timing wheel implementation that backs `Timer` /// This type provides the hashed timing wheel implementation that backs
/// and `DelayQueue`. /// [`Driver`].
/// ///
/// The structure is generic over `T: Stack`. This allows handling timeout data /// See [`Driver`] documentation for some implementation notes.
/// 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)] #[derive(Debug)]
pub(crate) struct Wheel { pub(crate) struct Wheel {
/// The number of milliseconds elapsed since the wheel started. /// The number of milliseconds elapsed since the wheel started.
tokio/src/runtime/time_alt/wheel/mod.rs
+3 -9
View File
@@ -7,17 +7,11 @@ use super::{EntryHandle, EntryList, WakeQueue};
use std::array; use std::array;
/// Timing wheel implementation. /// Hashed timing wheel implementation.
/// ///
/// This type provides the hashed timing wheel implementation that backs `Timer` /// See [`Driver`] documentation for some implementation notes.
/// and `DelayQueue`.
/// ///
/// The structure is generic over `T: Stack`. This allows handling timeout data /// [`Driver`]: crate::runtime::time::Driver
/// 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.
#[derive(Debug)] #[derive(Debug)]
pub(crate) struct Wheel { pub(crate) struct Wheel {
/// The number of milliseconds elapsed since the wheel started. /// The number of milliseconds elapsed since the wheel started.