Struct QueryTimeout 

pub struct QueryTimeout {
    pub deadline: Instant,
    pub cancelled: Arc<AtomicBool>,
    /* private fields */
}

A handle representing an active query timeout.

Created via QueryTimeout::new. Call QueryTimeout::check periodically inside inner query-execution loops to enforce the deadline.

Fields

deadline: Instant

cancelled: Arc<AtomicBool>

Implementations

impl QueryTimeout

pub fn new(duration: Duration) -> Self

Create a new timeout that expires after duration.

pub fn is_expired(&self) -> bool

Returns true if the timeout deadline has passed.

pub fn remaining(&self) -> Option<Duration>

Returns the remaining time until the deadline, or None if already expired.

pub fn cancel(&self)

Cancel the query externally. Future calls to QueryTimeout::check will return TimeoutError::QueryCancelled.

pub fn check(&self) -> Result<(), TimeoutError>

Check whether the timeout or cancellation has been triggered.

Call this in inner execution loops. Returns Ok(()) if execution should continue, or the appropriate Err variant otherwise.

pub fn cancellation_handle(&self) -> Arc<AtomicBool>

Obtain a cloneable cancellation handle that shares the same flag.