Struct TrackingNow

pub struct TrackingNow {
    instant: TrackingInstantNow,
    system_time: TrackingSystemTimeNow,
}

Timeout tracker that can handle both Instants and SystemTimes

Internally, the two kinds of timeouts are tracked separately: this contains a TrackingInstantNow and a TrackingSystemTimeNow.

Fields

instant: TrackingInstantNow

For Instants

system_time: TrackingSystemTimeNow

For SystemTimes

Implementations

impl TrackingNow

pub fn new(instant: Instant, system_time: SystemTime) -> TrackingNow

Creates a new combined timeout tracker, given values for the current time

pub fn now(r: &impl SleepProvider) -> Self

Creates a new timeout tracker from the current times as seen by a runtime

pub fn instant(&self) -> &TrackingInstantNow

Access the specific timeout tracker for Instant

pub fn system_time(&self) -> &TrackingSystemTimeNow

Access the specific timeout tracker for SystemTime

pub fn shortest(self) -> Option<Duration>

Return the shortest Duration until any future time with which this has been compared

impl TrackingNow

pub async fn wait_for_earliest(self, runtime: &impl SleepProvider)

Wait for the earliest timeout implied by any of the comparisons

Waits until the earliest future time at which any of the comparisons performed might change their answer.

If there were no comparisons there are no timeouts, so we wait forever.

impl TrackingNow

pub fn checked_sub( &self, offset: Duration, ) -> Option<TrackingInstantOffsetNow<'_>>

Return a tracker representing an Instant a specific offset before the current time

See TrackingInstantNow::checked_sub() for more details.

Instant-only

The returned tracker handles only Instants, for reasons relating to clock warps: broadly, waiting for a particular SystemTime must always be done by working with the future SystemTime at which to wake up; whereas, waiting for a particular Instant can be done by calculating Durationss.

For the same reason there is no .checked_sub() method on TrackingSystemTimeNow.

Trait Implementations

impl Clone for TrackingNow

fn clone(&self) -> TrackingNow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackingNow

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

Formats the value using the given formatter.

impl PartialEq<Instant> for TrackingNow

Check if time t has been reached yet (and if not, remember that we want to wake up then)

Always returns Some.

fn eq(&self, t: &Instant) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<SystemTime> for TrackingNow

Check if time t has been reached yet (and if not, remember that we want to wake up then)

Always returns Some.

fn eq(&self, t: &SystemTime) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<TrackingNow> for Instant

Check if we have reached time t yet (and if not, remember that we want to wake up then)

Always returns Some.

fn eq(&self, t: &TrackingNow) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<TrackingNow> for SystemTime

Check if we have reached time t yet (and if not, remember that we want to wake up then)

Always returns Some.

fn eq(&self, t: &TrackingNow) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Instant> for TrackingNow

Check if time t has been reached yet (and if not, remember that we want to wake up then)

Always returns Some.

fn partial_cmp(&self, t: &Instant) -> 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 PartialOrd<SystemTime> for TrackingNow

Check if time t has been reached yet (and if not, remember that we want to wake up then)

Always returns Some.

fn partial_cmp(&self, t: &SystemTime) -> 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 PartialOrd<TrackingNow> for Instant

Check if we have reached time t yet (and if not, remember that we want to wake up then)

Always returns Some.

fn partial_cmp(&self, t: &TrackingNow) -> 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 PartialOrd<TrackingNow> for SystemTime

Check if we have reached time t yet (and if not, remember that we want to wake up then)

Always returns Some.

fn partial_cmp(&self, t: &TrackingNow) -> 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 Update<Duration> for TrackingNow

fn update(&self, d: Duration)

Update the “earliest timeout” notion, to ensure it’s at least as early as t

impl Update<Instant> for TrackingNow

fn update(&self, t: Instant)

Update the “earliest timeout” notion, to ensure it’s at least as early as t

impl Update<SystemTime> for TrackingNow

fn update(&self, t: SystemTime)

Update the “earliest timeout” notion, to ensure it’s at least as early as t

impl Sealed for TrackingNow