Skip to main content

MockSleeper

Struct MockSleeper 

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

Relative sleeper driven by a crate::MockTimeline.

MockSleeper is the test implementation of Sleeper. It does not wait for real wall-clock time. Instead, each sleep captures a deadline on the backing crate::MockTimeline and completes only after that timeline has advanced to the deadline.

Cloned sleepers share the same timeline. A sleeper created through with_timeline can therefore be paired with a crate::MockClock or future monitor implementation that uses the same timeline. For most tests, crate::MockTime is the simpler way to create that shared runtime.

Blocking sleeps register themselves as crate::MockWaiterKind::Sleep so tests can use MockTimeline::wait_for_blocked_waiters before advancing time. With the tokio feature enabled, async sleeps use the same timeline and waiter registration model.

Implementations§

Source§

impl MockSleeper

Source

pub fn new() -> Self

Creates a mock sleeper with a fresh timeline.

§Returns

A sleeper backed by a new zero-elapsed timeline.

Source

pub fn with_timeline(timeline: MockTimeline) -> Self

Creates a mock sleeper backed by an existing timeline.

§Parameters
  • timeline: Shared mock timeline to wait on.
§Returns

A sleeper view over the provided timeline.

Source

pub fn timeline(&self) -> MockTimeline

Returns the timeline backing this sleeper.

§Returns

The shared mock timeline.

Trait Implementations§

Source§

impl Clone for MockSleeper

Source§

fn clone(&self) -> MockSleeper

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 Debug for MockSleeper

Source§

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

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

impl Default for MockSleeper

Source§

fn default() -> Self

Creates a mock sleeper with a fresh timeline.

Source§

impl Sleeper for MockSleeper

Source§

fn sleep_for(&self, duration: Duration)

Blocks until the shared mock timeline advances by duration.

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.