Struct Deadline 

pub struct Deadline { /* private fields */ }

A monotonic-time deadline for cooperative task cancellation.

Build one with Deadline::after (relative) or Deadline::at (absolute), then call Deadline::check_or_err between agent steps and Deadline::remaining when handing the timeout to a per-call API.

Deadlines are immutable. To tighten a deadline for a nested operation without touching the original, use Deadline::intersect.

Implementations

impl Deadline

pub fn after(duration: Duration) -> Self

Build a deadline that fires duration from now.

A Duration::ZERO produces an already-expired deadline, which is occasionally useful in tests.

pub fn at(instant: Instant) -> Self

Build a deadline that fires at an exact monotonic instant.

Use this when you already have an Instant from another source (for example a parent task’s deadline expressed as an Instant).

pub fn never() -> Self

A deadline that never fires.

Useful as a default for callers that may or may not want a cap. Self::remaining returns Duration::MAX, Self::expired is always false, and Self::check_or_err is a no-op.

pub fn is_never(&self) -> bool

true if this deadline was built with Deadline::never.

pub fn instant(&self) -> Option<Instant>

The absolute instant at which this deadline fires, if any.

Returns None for Deadline::never.

pub fn expired(&self) -> bool

true once the current monotonic time is at or past the deadline.

Always false for Deadline::never.

pub fn remaining(&self) -> Duration

Duration left until the deadline. Saturates at zero. Never negative.

Returns Duration::MAX for Deadline::never. Hand this to any timeout-taking API.

pub fn remaining_seconds(&self) -> f64

Convenience for callers that want the remaining time as f64 seconds.

Returns f64::INFINITY for Deadline::never.

pub fn elapsed(&self) -> Duration

Seconds since this deadline was constructed.

Survives an Self::intersect: the elapsed counter still measures against the original task start.

pub fn check_or_err(&self) -> Result<(), DeadlineExceeded>

Cooperative check: return Err(DeadlineExceeded) if the deadline has passed.

No-op for Deadline::never. Call between agent steps.

pub fn intersect(&self, other: &Deadline) -> Deadline

Return a new deadline that fires at the earlier of self and other.

created_at is preserved from self so Self::elapsed keeps measuring against the original task start, not the intersection point.

pub fn intersect_after(&self, duration: Duration) -> Deadline

Convenience: intersect with a deadline duration from now.

Trait Implementations

impl Clone for Deadline

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Deadline

impl Debug for Deadline

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

Formats the value using the given formatter.

impl Default for Deadline

fn default() -> Self

Default deadline is Deadline::never. Useful in struct fields where “no cap” is the sane default.

impl Eq for Deadline

impl PartialEq for Deadline

fn eq(&self, other: &Self) -> bool

Two deadlines compare equal when they fire at the same instant (or both are never). created_at is not part of identity.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.