Struct Timer 

pub struct Timer { /* private fields */ }

Timer handle for managing one-time and recurring tasks.

Implementations

impl Timer

pub fn new() -> Self

Creates a new timer.

pub fn new_silent() -> Self

Creates a new timer with broadcast events disabled.

pub fn once(delay: Duration) -> TimerBuilder

Creates a timer builder configured for a one-time run.

pub fn at(deadline: Instant) -> TimerBuilder

Creates a timer builder configured for a one-time run at a deadline.

pub fn recurring(schedule: RecurringSchedule) -> TimerBuilder

Creates a timer builder configured for a recurring schedule.

pub fn subscribe(&self) -> TimerEvents

Subscribes to future timer events.

pub fn completion(&self) -> TimerCompletion

Subscribes to completed runs without loss.

pub async fn start_once<F>( &self, delay: Duration, callback: F, ) -> Result<u64, TimerError>

where F: TimerCallback + 'static,

Starts a one-time timer.

pub async fn start_once_fn<F, Fut>( &self, delay: Duration, callback: F, ) -> Result<u64, TimerError>

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), TimerError>> + Send + 'static,

Starts a one-time timer from an async closure.

pub async fn start_at<F>( &self, deadline: Instant, callback: F, ) -> Result<u64, TimerError>

where F: TimerCallback + 'static,

Starts a one-time timer that fires at the provided deadline.

pub async fn start_at_fn<F, Fut>( &self, deadline: Instant, callback: F, ) -> Result<u64, TimerError>

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), TimerError>> + Send + 'static,

Starts a one-time timer from an async closure at the provided deadline.

pub async fn start_recurring<F>( &self, schedule: RecurringSchedule, callback: F, ) -> Result<u64, TimerError>

where F: TimerCallback + 'static,

Starts a recurring timer with the provided schedule.

pub async fn start_recurring_fn<F, Fut>( &self, schedule: RecurringSchedule, callback: F, ) -> Result<u64, TimerError>

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), TimerError>> + Send + 'static,

Starts a recurring timer from an async closure.

pub async fn pause(&self) -> Result<(), TimerError>

Pauses a running timer.

pub async fn request_pause(&self) -> Result<(), TimerError>

Requests that the current run pause after the current callback or sleep edge.

pub async fn resume(&self) -> Result<(), TimerError>

Resumes a paused timer.

pub async fn request_resume(&self) -> Result<(), TimerError>

Requests that a paused timer resume.

pub async fn stop(&self) -> Result<TimerOutcome, TimerError>

Stops the timer after the current callback finishes.

pub async fn request_stop(&self) -> Result<(), TimerError>

Requests a graceful stop without waiting for the outcome.

pub async fn cancel(&self) -> Result<TimerOutcome, TimerError>

Cancels the timer immediately and aborts the callback task.

pub async fn request_cancel(&self) -> Result<(), TimerError>

Requests cancellation without aborting the active callback task.

pub async fn adjust_interval( &self, new_interval: Duration, ) -> Result<(), TimerError>

Adjusts the interval of a running or paused timer.

pub async fn request_adjust_interval( &self, new_interval: Duration, ) -> Result<(), TimerError>

Requests an interval adjustment for the current run.

pub async fn join(&self) -> Result<TimerOutcome, TimerError>

Waits for the current run and returns the completed outcome.

pub async fn wait(&self)

Waits until the current run has completed or been stopped.

pub async fn get_statistics(&self) -> TimerStatistics

Gets the timer’s statistics for the current or most recent run.

pub async fn get_state(&self) -> TimerState

Gets the current state of the timer.

pub async fn get_interval(&self) -> Duration

Gets the timer interval for the current or next run.

pub async fn get_expiration_count(&self) -> Option<usize>

Gets the configured expiration count for the current or next run.

pub async fn get_last_error(&self) -> Option<TimerError>

Gets the most recent callback error observed for the current or most recent run.

pub async fn metadata(&self) -> TimerMetadata

Returns the metadata currently associated with the timer.

pub async fn label(&self) -> Option<String>

Returns the current label, if one has been assigned.

pub async fn set_label(&self, label: impl Into<String>)

Sets the timer label used for diagnostics and registry introspection.

pub async fn set_tag(&self, key: impl Into<String>, value: impl Into<String>)

Sets or replaces a metadata tag on the timer.

pub async fn snapshot(&self) -> TimerSnapshot

Captures a snapshot of the timer’s current observable state.

pub async fn last_outcome(&self) -> Option<TimerOutcome>

Gets the most recent completed run outcome.

pub fn set_events_enabled(&self, enabled: bool)

Enables or disables broadcast event emission for future runtime events.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Timer

fn default() -> Self

Returns the “default value” for a type.