Struct WheelTimer

Source
pub struct WheelTimer { /* private fields */ }
Expand description

A reference-counted handle to a time wheel-based timer.

§Examples

use wheeltimer::WheelTimer;

#[tokio::main]
async fn main() {
    let timer = WheelTimer::new(tokio::time::Duration::from_millis(100), 1024, 100000).unwrap();
    timer.start().await;
    let timeout = timer.new_timeout(tokio::time::Duration::from_secs(2),
        async move {
            // async task logic here
            println!("a delay task is executed");
        }
    ).await;

    tokio::time::sleep(tokio::time::Duration::from_secs(3)).await;
    timer.stop().await;
}

Implementations§

Source§

impl WheelTimer

Source

pub fn new( tick_duration: Duration, ticks_per_wheel: u32, max_pending_timeouts: u64, ) -> Result<Self, Error>

Source

pub async fn start(&self)

Source

pub async fn stop(&self)

Source

pub async fn new_timeout<F>( &self, delay: Duration, task: F, ) -> Result<Timeout, Error>
where F: Future<Output = ()> + Send + 'static,

Source

pub fn pending_timeouts(&self) -> u64

Trait Implementations§

Source§

impl Clone for WheelTimer

Source§

fn clone(&self) -> WheelTimer

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.