Struct ArcMockMonitor 

pub struct ArcMockMonitor<T> { /* private fields */ }

Cloneable handle around a MockMonitor.

Implementations

impl<T> ArcMockMonitor<T>

pub fn new(state: T) -> Self

Creates an Arc-wrapped mock monitor.

Arguments

• state - Initial protected state.

Returns

A cloneable mock monitor handle.

pub fn elapsed(&self) -> Duration

Returns the current mock elapsed time.

pub fn set_elapsed(&self, elapsed: Duration)

Sets the current mock elapsed time.

Arguments

• elapsed - New mock elapsed time.

pub fn advance(&self, duration: Duration)

Advances mock elapsed time.

Arguments

• duration - Duration added to current mock elapsed time.

pub fn reset_elapsed(&self)

Resets mock elapsed time to zero.

pub fn read<R, F>(&self, f: F) -> R

where F: FnOnce(&T) -> R,

Reads protected state.

pub fn write<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Mutates protected state without notifying.

pub fn write_notify_one<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Mutates protected state and wakes one waiter.

pub fn write_notify_all<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Mutates protected state and wakes all waiters.

pub fn notify_one(&self)

Wakes one waiter.

pub fn notify_all(&self)

Wakes all waiters.

Methods from Deref<Target = MockMonitor<T>>

pub fn elapsed(&self) -> Duration

Returns the current mock elapsed time.

Returns

The elapsed time used by timeout waits.

pub fn set_elapsed(&self, elapsed: Duration)

Sets the current mock elapsed time.

This wakes timeout waiters so they can recheck their budgets.

Arguments

• elapsed - New mock elapsed time.

pub fn advance(&self, duration: Duration)

Advances mock elapsed time by a relative duration.

Arguments

• duration - Duration added to the current mock elapsed time.

pub fn reset_elapsed(&self)

Resets mock elapsed time to zero.

pub fn read<R, F>(&self, f: F) -> R

where F: FnOnce(&T) -> R,

Acquires the monitor and reads the protected state.

Arguments

• f - Closure that receives an immutable reference to the state.

Returns

The value returned by the closure.

pub fn write<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Acquires the monitor and mutates the protected state.

This does not notify waiters automatically.

Arguments

• f - Closure that receives a mutable reference to the state.

Returns

The value returned by the closure.

pub fn write_notify_one<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Mutates the protected state and wakes one waiter.

Arguments

• f - Closure that receives a mutable reference to the state.

Returns

The value returned by the closure.

pub fn write_notify_all<R, F>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Mutates the protected state and wakes all waiters.

Arguments

• f - Closure that receives a mutable reference to the state.

Returns

The value returned by the closure.

pub fn notify_one(&self)

Wakes one waiter if one is blocked.

pub fn notify_all(&self)

Wakes all waiters.

Trait Implementations

impl<T> AsRef<MockMonitor<T>> for ArcMockMonitor<T>

fn as_ref(&self) -> &MockMonitor<T>

Returns a reference to the wrapped mock monitor.

impl<T: Send> AsyncConditionWaiter for ArcMockMonitor<T>

Available on crate feature async only.

fn async_wait_until<'a, R, P, F>( &'a self, predicate: P, action: F, ) -> AsyncMonitorFuture<'a, R>

where R: Send + 'a, P: FnMut(&Self::State) -> bool + Send + 'a, F: FnOnce(&mut Self::State) -> R + Send + 'a,

Returns a future that waits until the predicate becomes true.

fn async_wait_while<'a, R, P, F>( &'a self, predicate: P, action: F, ) -> AsyncMonitorFuture<'a, R>

where R: Send + 'a, P: FnMut(&Self::State) -> bool + Send + 'a, F: FnOnce(&mut Self::State) -> R + Send + 'a,

Returns a future that waits while the predicate remains true.

type State = T

State protected by the monitor.

impl<T: Send> AsyncNotificationWaiter for ArcMockMonitor<T>

Available on crate feature async only.

fn async_wait<'a>(&'a self) -> AsyncMonitorFuture<'a, ()>

Returns a future that resolves after an async notification.

impl<T: Send> AsyncTimeoutConditionWaiter for ArcMockMonitor<T>

Available on crate feature async only.

fn async_wait_until_for<'a, R, P, F>( &'a self, timeout: Duration, predicate: P, action: F, ) -> AsyncMonitorFuture<'a, WaitTimeoutResult<R>>

where R: Send + 'a, P: FnMut(&Self::State) -> bool + Send + 'a, F: FnOnce(&mut Self::State) -> R + Send + 'a,

Returns a future that waits until the predicate becomes true or times out.

fn async_wait_while_for<'a, R, P, F>( &'a self, timeout: Duration, predicate: P, action: F, ) -> AsyncMonitorFuture<'a, WaitTimeoutResult<R>>

where R: Send + 'a, P: FnMut(&Self::State) -> bool + Send + 'a, F: FnOnce(&mut Self::State) -> R + Send + 'a,

Returns a future that waits while the predicate remains true or times out.

impl<T: Send> AsyncTimeoutNotificationWaiter for ArcMockMonitor<T>

Available on crate feature async only.

fn async_wait_for<'a>( &'a self, timeout: Duration, ) -> AsyncMonitorFuture<'a, WaitTimeoutStatus>

Returns a future that resolves after notification or mock timeout.

impl<T> Clone for ArcMockMonitor<T>

fn clone(&self) -> Self

Clones this shared mock monitor handle.

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

Performs copy-assignment from source.

impl<T> ConditionWaiter for ArcMockMonitor<T>

fn wait_until<R, P, F>(&self, predicate: P, action: F) -> R

where P: FnMut(&Self::State) -> bool, F: FnOnce(&mut Self::State) -> R,

Blocks until the predicate becomes true, then runs the action.

fn wait_while<R, P, F>(&self, predicate: P, action: F) -> R

where P: FnMut(&Self::State) -> bool, F: FnOnce(&mut Self::State) -> R,

Blocks while the predicate remains true, then runs the action.

type State = T

State protected by the monitor.

impl<T: Default> Default for ArcMockMonitor<T>

fn default() -> Self

Creates an Arc-wrapped mock monitor containing T::default().

impl<T> Deref for ArcMockMonitor<T>

fn deref(&self) -> &Self::Target

Dereferences to the wrapped mock monitor.

type Target = MockMonitor<T>

The resulting type after dereferencing.

impl<T> From<T> for ArcMockMonitor<T>

fn from(value: T) -> Self

Creates an Arc-wrapped mock monitor from an initial state value.

impl<T> NotificationWaiter for ArcMockMonitor<T>

fn wait(&self)

Blocks until notification.

impl<T> Notifier for ArcMockMonitor<T>

fn notify_one(&self)

Wakes one waiter.

fn notify_all(&self)

Wakes all waiters.

impl<T> TimeoutConditionWaiter for ArcMockMonitor<T>

fn wait_until_for<R, P, F>( &self, timeout: Duration, predicate: P, action: F, ) -> WaitTimeoutResult<R>

where P: FnMut(&Self::State) -> bool, F: FnOnce(&mut Self::State) -> R,

Blocks until the predicate becomes true or mock timeout expires.

fn wait_while_for<R, P, F>( &self, timeout: Duration, predicate: P, action: F, ) -> WaitTimeoutResult<R>

where P: FnMut(&Self::State) -> bool, F: FnOnce(&mut Self::State) -> R,

Blocks while the predicate remains true or until mock timeout expires.

impl<T> TimeoutNotificationWaiter for ArcMockMonitor<T>

fn wait_for(&self, timeout: Duration) -> WaitTimeoutStatus

Blocks until notification or mock timeout.