Struct HrTimer

#[repr(C)]
pub struct HrTimer<T> { /* private fields */ }

A timer backed by a C struct hrtimer.

Invariants

• self.timer is initialized by bindings::hrtimer_setup.

Implementations

impl<T> HrTimer<T>

pub fn new() -> impl PinInit<Self>

where T: HrTimerCallback + HasHrTimer<T>,

Return an initializer for a new timer instance.

pub fn forward( self: Pin<&mut Self>, now: HrTimerInstant<T>, interval: Delta, ) -> u64

where T: HasHrTimer<T>,

Conditionally forward the timer.

If the timer expires after now, this function does nothing and returns 0. If the timer expired at or before now, this function forwards the timer by interval until the timer expires after now and then returns the number of times the timer was forwarded by interval.

This function is mainly useful for timer types which can provide exclusive access to the timer when the timer is not running. For forwarding the timer from within the timer callback context, see HrTimerCallbackContext::forward().

Returns the number of overruns that occurred as a result of the timer expiry change.

pub fn forward_now(self: Pin<&mut Self>, interval: Delta) -> u64

where T: HasHrTimer<T>,

Conditionally forward the timer.

This is a variant of forward() that uses an interval after the current time of the base clock for the HrTimer.

pub fn expires(&self) -> HrTimerInstant<T>

where T: HasHrTimer<T>,

Return the time expiry for this HrTimer.

This value should only be used as a snapshot, as the actual expiry time could change after this function is called.

Trait Implementations

impl<T> HasPinData for HrTimer<T>

type PinData = __ThePinData<T>

unsafe fn __pin_data() -> Self::PinData

impl<T> Send for HrTimer<T>

impl<T> Sync for HrTimer<T>