Skip to main content

TimerBuilder

Struct TimerBuilder 

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

Builds and starts a timer with less boilerplate.

Implementations§

Source§

impl TimerBuilder

Source

pub fn once(delay: Duration) -> Self

Creates a builder for a one-time timer.

Source

pub fn at(deadline: Instant) -> Self

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

Source

pub fn recurring(schedule: RecurringSchedule) -> Self

Creates a builder for a recurring schedule.

Source

pub fn callback_timeout(self, callback_timeout: Duration) -> Self

Sets a timeout for each callback execution.

Source

pub fn retry_policy(self, retry_policy: RetryPolicy) -> Self

Retries failed callback executions according to the provided policy.

Source

pub fn max_retries(self, max_retries: usize) -> Self

Retries failed callback executions up to max_retries times.

Source

pub fn fixed_backoff(self, delay: Duration) -> Self

Applies a fixed delay between retry attempts.

Source

pub fn linear_backoff(self, step: Duration) -> Self

Applies a linearly increasing delay between retry attempts.

Source

pub fn exponential_backoff(self, base: Duration) -> Self

Applies an exponentially increasing delay between retry attempts.

Source

pub fn paused_start(self) -> Self

Starts the timer in the paused state.

Source

pub fn with_events_disabled(self) -> Self

Disables broadcast event emission for the timer.

Source

pub fn label(self, label: impl Into<String>) -> Self

Sets a label for the started timer.

Source

pub fn tag(self, key: impl Into<String>, value: impl Into<String>) -> Self

Adds a metadata tag for the started timer.

Source

pub async fn start<F>(self, callback: F) -> Result<Timer, TimerError>
where F: TimerCallback + 'static,

Starts the configured timer and returns the handle.

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> 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, 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.