Struct WithTimeout 

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

A Stop wrapper that adds a deadline.

The wrapped stop will return StopReason::TimedOut if the deadline passes, or propagate the inner stop’s reason if it stops first.

Cost

Every check reads the clock (Instant::now()). Measured with perf on a loop that checks after every 1 KiB of PNG defiltering (record), that is about 112 instructions per check, and the loop took 22% more cycles on x86-64 (12% on a Neoverse-N1); a plain Stopper measured within noise. In return it stops no later than one check after the deadline.

If a library checks that often and the deadline doesn’t need that precision, DebouncedTimeout reads the clock only every N checks, at most 64, with N timed from two consecutive checks so that reads come about once per 100 µs. After checks slow down it can stop up to 64 of the slower checks late, unless the code holding it calls clear_calibration where the pace changes.

Example

use almost_enough::{StopSource, Stop};
use almost_enough::time::WithTimeout;
use std::time::Duration;

let source = StopSource::new();
let timeout = WithTimeout::new(source.as_ref(), Duration::from_millis(100));

assert!(!timeout.should_stop());

std::thread::sleep(Duration::from_millis(150));
assert!(timeout.should_stop());

Implementations

impl<T: Stop> WithTimeout<T>

pub fn new(inner: T, duration: Duration) -> Self

Create a new timeout wrapper.

The deadline is calculated as Instant::now() + duration.

pub fn with_deadline(inner: T, deadline: Instant) -> Self

Create a timeout wrapper with an absolute deadline.

pub fn deadline(&self) -> Instant

Get the deadline.

pub fn remaining(&self) -> Duration

Get the remaining time until deadline.

Returns Duration::ZERO if the deadline has passed.

pub fn inner(&self) -> &T

Get a reference to the inner stop.

pub fn into_inner(self) -> T

Unwrap and return the inner stop.

impl<T: Stop> WithTimeout<T>

pub fn tighten(self, duration: Duration) -> Self

Add another timeout, taking the tighter of the two deadlines.

This prevents timeout nesting by updating the deadline in place.

pub fn tighten_deadline(self, deadline: Instant) -> Self

Add another deadline, taking the earlier of the two.

This prevents timeout nesting by updating the deadline in place.

Trait Implementations

impl<T: Clone> Clone for WithTimeout<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WithTimeout<T>

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

Formats the value using the given formatter.

impl<T: Stop> Stop for WithTimeout<T>

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.

fn may_stop(&self) -> bool

Returns true if this stop can ever signal a stop.