pub struct SchedulerHandle { /* private fields */ }Expand description
Handle to the timer scheduler.
Used to schedule timers and shutdown the scheduler. Cloning the handle creates another reference to the same scheduler.
Implementations§
Source§impl SchedulerHandle
impl SchedulerHandle
Sourcepub fn new(pool: Arc<ThreadPool>) -> Self
pub fn new(pool: Arc<ThreadPool>) -> Self
Create and start a new scheduler.
Timer callbacks are dispatched to the given rayon thread pool.
Sourcepub fn schedule_once<F>(&self, delay: Duration, callback: F) -> TimerHandle
pub fn schedule_once<F>(&self, delay: Duration, callback: F) -> TimerHandle
Schedule a callback to fire once after a delay.
Returns a handle that can be used to cancel the timer.
Sourcepub fn schedule_repeat<F>(&self, interval: Duration, callback: F) -> TimerHandle
pub fn schedule_repeat<F>(&self, interval: Duration, callback: F) -> TimerHandle
Schedule a callback to fire repeatedly at an interval.
The callback returns true to continue or false to stop.
Returns a handle that can be used to cancel the timer.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SchedulerHandle
impl !RefUnwindSafe for SchedulerHandle
impl Send for SchedulerHandle
impl Sync for SchedulerHandle
impl Unpin for SchedulerHandle
impl UnsafeUnpin for SchedulerHandle
impl !UnwindSafe for SchedulerHandle
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more