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.

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) -> WithTimeout<T>

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.