Struct base::timer::FakeTimer

pub struct FakeTimer {
    clock: Arc<Mutex<FakeClock>>,
    deadline_ns: Option<u64>,
    interval: Option<Duration>,
    event: Event,
}

FakeTimer: For use in tests.

Fields

clock: Arc<Mutex<FakeClock>>

deadline_ns: Option<u64>

interval: Option<Duration>

event: Event

Implementations

impl FakeTimer

pub fn new(clock: Arc<Mutex<FakeClock>>) -> Self

Creates a new fake Timer. The timer is initally disarmed and must be armed by calling reset.

fn reset(&mut self, dur: Duration) -> Result<()>

fn wait_for(&mut self, timeout: Option<Duration>) -> Result<WaitResult>

Waits until the timer expires or an optional wait timeout expires, whichever happens first.

Returns

• WaitResult::Expired if the timer expired.
• WaitResult::Timeout if timeout was not None and the timer did not expire within the specified timeout period.

Trait Implementations

impl AsRawDescriptor for FakeTimer

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl IntoRawDescriptor for FakeTimer

fn into_raw_descriptor(self) -> RawDescriptor

impl TimerTrait for FakeTimer

fn reset_oneshot(&mut self, dur: Duration) -> Result<()>

Sets the timer to expire after dur without repeating. Cancels any existing timer.

fn reset_repeating(&mut self, dur: Duration) -> Result<()>

Sets the timer to fire repeatedly at dur intervals. Cancels any existing timer.

fn wait(&mut self) -> Result<()>

Waits until the timer expires.

fn mark_waited(&mut self) -> Result<bool>

After a timer is triggered from an EventContext, mark the timer as having been waited for. If a timer is not marked waited, it will immediately trigger the event context again. This does not need to be called after calling Timer::wait.

fn clear(&mut self) -> Result<()>

Disarms the timer.

fn resolution(&self) -> Result<Duration>

Returns the resolution of timers on the host.