mirror of
https://github.com/tokio-rs/tokio.git
synced 2026-08-18 00:00:09 +02:00
time: update outdated docs of Wheel (#7749)
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user