Skip to main content

TimerOverrunPolicy

Enum TimerOverrunPolicy 

Source
pub enum TimerOverrunPolicy {
    Skip,
    CatchUp,
}
Expand description

What a periodic timer does with periods it missed while its executor was blocked (issue #505).

A tier that loses the CPU for several periods — a long-running callback, or preemption by a higher-priority band — resumes with accumulated elapsed time worth more than one period.

Variants§

§

Skip

Coalesce the backlog: fire ONCE and drop the missed periods, counting them in overruns. Phase is preserved (the sub-period remainder carries over), so activations stay aligned to the original cadence grid instead of drifting by each stall.

The default, matching rclcpp (which advances the next call time past “now”) and Zephyr’s k_timer (which coalesces expiries and reports a count).

§

CatchUp

Replay every missed period, one activation per try_process pass, until the backlog drains. Correct for timers that count or accumulate, where each activation is a unit of work that must not be lost. A replay burst runs back-to-back at dispatch speed, NOT at the declared cadence — control loops usually want Skip.

Trait Implementations§

Source§

impl Clone for TimerOverrunPolicy

Source§

fn clone(&self) -> TimerOverrunPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TimerOverrunPolicy

Source§

impl Debug for TimerOverrunPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TimerOverrunPolicy

Source§

fn default() -> TimerOverrunPolicy

Returns the “default value” for a type. Read more
Source§

impl Eq for TimerOverrunPolicy

Source§

impl PartialEq for TimerOverrunPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for TimerOverrunPolicy

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.