InactiveClock

Struct InactiveClock 

Source
pub struct InactiveClock(/* private fields */);
Expand description

An inactive clock that must be activated before time operations can be performed.

This type represents a clock in an inactive state that cannot perform any time-related operations until activated. It can be safely cloned and moved across threads, making it suitable for initialization in multi-threaded environments.

To begin using the clock, call InactiveClock::activate to get a working Clock instance and its associated ClockDriver. The driver is responsible for advancing timers and must be called periodically by the runtime.

§Examples

use tick::runtime::InactiveClock;

let inactive = InactiveClock::default();
let (clock, driver) = inactive.activate();

// Use the clock for time operations
let now = clock.instant();

// Driver must be advanced periodically (typically by the runtime)
// driver.advance_timers();

§Thread-per-core runtimes

Thread-per-core runtimes can activate separate clock instances per thread by cloning the InactiveClock before activation. This eliminates lock contention and improves performance.

Implementations§

Source§

impl InactiveClock

Source

pub fn activate(self) -> (Clock, ClockDriver)

Activates the clock for time operations.

Consumes this inactive clock and returns a working Clock instance along with its ClockDriver. The driver must be called periodically to advance timers.

§Returns

A tuple containing:

  • Clock - The activated clock instance for time operations
  • ClockDriver - Driver that advances timers (must be polled by caller)

Trait Implementations§

Source§

impl Clone for InactiveClock

Source§

fn clone(&self) -> InactiveClock

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InactiveClock

Source§

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

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

impl Default for InactiveClock

Source§

fn default() -> InactiveClock

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

impl From<ClockControl> for InactiveClock

Available on crate features test-util only.
Source§

fn from(control: ClockControl) -> Self

Converts to this type from the input type.

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.