Struct RecurringSchedule 

pub struct RecurringSchedule { /* private fields */ }

Configures the schedule for a recurring timer.

Implementations

impl RecurringSchedule

pub fn new(interval: Duration) -> Self

Creates a recurring schedule from a fixed interval.

pub fn interval(self) -> Duration

Returns the recurring interval.

pub fn initial_delay(self) -> Option<Duration>

Returns the initial delay before the first execution.

pub fn cadence(self) -> RecurringCadence

Returns the cadence used for the recurring schedule.

pub fn expiration_count(self) -> Option<usize>

Returns the optional execution limit.

pub fn jitter(self) -> Option<Duration>

Returns the optional jitter applied to recurring sleeps.

pub fn with_initial_delay(self, initial_delay: Duration) -> Self

Sets an initial delay before the first recurring execution.

pub fn with_cadence(self, cadence: RecurringCadence) -> Self

Sets the cadence used for subsequent executions.

pub fn fixed_delay(self) -> Self

Uses fixed-delay cadence semantics.

pub fn fixed_rate(self) -> Self

Uses fixed-rate cadence semantics.

pub fn with_expiration_count(self, expiration_count: usize) -> Self

Limits the number of recurring executions.

pub fn with_jitter(self, jitter: Duration) -> Self

Adds bounded jitter to recurring delays.

Trait Implementations

impl Clone for RecurringSchedule

fn clone(&self) -> RecurringSchedule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RecurringSchedule

impl Debug for RecurringSchedule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for RecurringSchedule

impl PartialEq for RecurringSchedule

fn eq(&self, other: &RecurringSchedule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RecurringSchedule