Struct TimeoutGuard

Source

pub struct TimeoutGuard<C = SystemTimeoutClock> { /* private fields */ }

Expand description

Deterministic timeout guard wrapper with enforcement.

The TimeoutGuard extends TimeoutClassifier with active timeout enforcement via cancellation signaling when a timeout occurs.

Implementations§

Source §

impl TimeoutGuard<SystemTimeoutClock>

Source

pub fn new() -> Self

Creates a timeout guard using the default system clock.

Source §

impl<C> TimeoutGuard<C>
where C: TimeoutClock,

Source

pub fn with_clock(clock: C) -> Self

Creates a timeout guard with an explicit clock implementation.

Source

pub fn with_poll_interval(self, interval: Duration) -> Self

Sets the watchdog poll interval. Default is 1ms.

Source

pub fn execute<T, F>( &self, timeout_secs: Option<u64>, operation: F, ) -> GuardedExecution<T>
where F: FnOnce() -> T,

Executes operation, captures elapsed time, and classifies timeout outcome.

The timeout decision is deterministic for a given (timeout_secs, elapsed). This method is provided for backward compatibility; use TimeoutClassifier::execute_and_classify when only classification is needed without any enforcement semantics.

Source

pub fn execute_with_cancellation<T, F>( &self, timeout_secs: Option<u64>, operation: F, ) -> CancellableExecution<T>
where F: FnOnce(&CancellationContext) -> T,

Executes operation with cancellation support, capturing elapsed time and classifying timeout.

When a timeout is configured, this method starts an attempt-local watchdog worker. The watchdog sleeps until the timeout deadline and requests cancellation if the operation has not completed yet. The watchdog is deterministically joined before returning from this method.

Timeout classification remains inspectable output, but enforcement does not depend on post-return classification. Enforcement (cancellation request) can happen during active handler execution.

Cleanup invariant: watchdog lifecycle is panic-safe and always joined via scoped lifecycle teardown before return or unwind propagation.

Source

pub fn execute_with_external_cancellation<T, F>( &self, timeout_secs: Option<u64>, cancellation_context: CancellationContext, operation: F, ) -> CancellableExecution<T>
where F: FnOnce(&CancellationContext) -> T,

Executes operation with an externally-provided cancellation context.

Identical to execute_with_cancellation except the caller supplies the CancellationContext. This allows the dispatch loop to retain a clone of the context so it can signal cancellation (e.g. budget exhaustion) while the handler is running.