Struct mesh_channel::cancel::Deadline

pub struct Deadline { /* private fields */ }

A point in time that acts as a deadline for an operation.

A deadline internally tracks both wall-clock time and, optionally, OS monotonic time. When two deadlines are compared, monotonic time is preferred, but if one or more deadlines do not have monotonic time, wall-clock time is used.

When a deadline is serialized, only its wall-clock time is serialized. The monotonic time is not useful outside of the process that generated it, since the monotonic time is not guaranteed to be consistent across processes.

Implementations

impl Deadline

pub fn now() -> Self

Returns a new deadline representing the current time.

This will capture both wall-clock time and monotonic time.

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

The monotonic OS instant of the deadline, if there is one.

pub fn system_time(&self) -> SystemTime

The wall-clock time of the deadline.

pub fn checked_add(&self, duration: Duration) -> Option<Self>

Adds a duration to the deadline, returning None on overflow.

Trait Implementations

impl Add<Duration> for Deadline

type Output = Deadline

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Self::Output

Performs the + operation.

impl Clone for Deadline

fn clone(&self) -> Deadline

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Deadline

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

Formats the value using the given formatter.

impl From<Deadline> for Timestamp

fn from(deadline: Deadline) -> Self

Converts to this type from the input type.

impl From<SystemTime> for Deadline

fn from(system_time: SystemTime) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Deadline

fn from(timestamp: Timestamp) -> Self

Converts to this type from the input type.

impl Ord for Deadline

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Deadline

fn eq(&self, other: &Self) -> 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 for Deadline

fn partial_cmp(&self, other: &Self) -> 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 Sub<Duration> for Deadline

type Output = Deadline

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Self::Output

Performs the - operation.

impl Sub for Deadline

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, rhs: Deadline) -> Self::Output

Performs the - operation.

impl Copy for Deadline

impl Eq for Deadline