Struct Deadline 

pub struct Deadline(/* private fields */);

A point on a clock’s monotonic timeline, in milliseconds.

Caller-driven components report deadlines so the host knows how long it may idle before polling again. A deadline is only comparable to Now samples from the same Clock, since monotonic epochs are arbitrary.

Ordering is chronological, so the earliest deadline in a collection is its minimum and NEVER sorts last.

Absent versus distant deadlines

“Nothing scheduled” is expressed as Option::None, not as NEVER. NEVER is the saturating result of arithmetic that overflows past the end of the timeline, and it never expires.

Implementations

impl Deadline

pub const NEVER: Self

A deadline that never expires.

Produced by saturating arithmetic such as Now::deadline_after with a huge delay.

pub const IMMEDIATE: Self

A deadline that has already expired.

Expired at every point on every timeline, so a component with work buffered can report “poll me again without idling” without knowing what the host’s clock currently reads.

pub const fn from_millis(millis: u64) -> Self

Creates a deadline that expires when monotonic time reaches millis.

pub const fn as_millis(self) -> u64

Returns the monotonic milliseconds value this deadline expires at.

pub const fn is_never(self) -> bool

Returns whether this deadline never expires.

pub const fn is_expired_at(self, now: Now) -> bool

Returns whether this deadline has expired as of now.

NEVER is never expired, even at the end of the timeline.

pub const fn millis_until(self, now: Now) -> u64

Returns the milliseconds remaining until this deadline, or zero if it has already expired.

NEVER always reports u64::MAX remaining, however far monotonic time has advanced, so it stays consistent with is_expired_at never reporting it as due.

pub const fn saturating_add_millis(self, millis: u64) -> Self

Returns a deadline millis later, saturating at NEVER.

pub const fn earliest(self, other: Self) -> Self

Returns whichever of the two deadlines comes first.

pub const fn earliest_opt( left: Option<Self>, right: Option<Self>, ) -> Option<Self>

Merges two optional deadlines, keeping whichever comes first.

Useful for folding the deadlines of several subsystems into the one a runtime reports to its host.

Trait Implementations

impl Clone for Deadline

fn clone(&self) -> Deadline

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 Display for Deadline

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

Formats the value using the given formatter.

impl Eq for Deadline

impl From<Deadline> for u64

fn from(value: Deadline) -> Self

Converts to this type from the input type.

impl From<u64> for Deadline

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Deadline

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Deadline

fn cmp(&self, other: &Deadline) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Deadline

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Deadline

fn partial_cmp(&self, other: &Deadline) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Deadline