Skip to main content

PausedClock

Struct PausedClock 

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

Fully-virtual clock for tests.

Stores its own wall-clock cursor and a monotonic counter. Sleeps suspend on an internal Notify and wake when PausedClock::advance or PausedClock::set crosses the deadline. No tokio-runtime cooperation is required: PausedClock works inside current_thread, multi_thread, and start_paused runtimes equally well.

Pairs with tokio::time::pause() for tests that mix this clock with code that uses tokio::time::sleep directly (e.g. tokio::time::timeout).

Implementations§

Source§

impl PausedClock

Source

pub fn new(origin: OffsetDateTime) -> Arc<Self>

Build a paused clock pinned at origin.

Source

pub fn advance(&self, duration: Duration)

Advance wall + monotonic by duration and wake any sleepers whose deadlines are now in the past.

Source

pub fn advance_time(&self, duration: Duration)

Advance using a time::Duration. Negative durations are clamped to zero.

Source

pub fn advance_ticks(&self, ticks: u32, tick: Duration)

Step ticks times by tick, notifying sleepers between every step so tasks observing intermediate wake-ups see each notification.

Source

pub fn set(&self, wall: OffsetDateTime)

Pin the wall clock to wall. Monotonic counter advances by the (signed) delta, never moving backwards.

Trait Implementations§

Source§

impl Clock for PausedClock

Source§

fn now_utc(&self) -> OffsetDateTime

Current wall-clock UTC time.
Source§

fn monotonic_ms(&self) -> i64

Monotonic milliseconds since an implementation-defined origin. Read more
Source§

fn sleep<'life0, 'async_trait>( &'life0 self, duration: Duration, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Sleep for duration. No-op when duration is zero.
Source§

fn sleep_until_utc<'life0, 'async_trait>( &'life0 self, deadline: OffsetDateTime, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Sleep until the wall-clock UTC deadline. No-op if deadline is in the past.
Source§

impl Debug for PausedClock

Source§

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

Formats the value using the given formatter. Read more

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.