Struct Deadline

pub struct Deadline(pub DInstant);

Represents a timeout instant.

Deadlines and timeouts can be specified as a DInstant in the future or as a Duration from now, both of these types can be converted to this struct.

Examples

In the example below the timer function accepts Deadline, DInstant and Duration inputs.

fn timer(deadline: impl Into<Deadline>) {
    let deadline = deadline.into();
    // ..
}

timer(5.secs());

Tuple Fields

0: DInstant

Implementations

impl Deadline

pub const ELAPSED: Deadline = _

Deadline that is always elapsed.

pub const MAX: Deadline = _

Deadline that is practically never reached.

pub fn timeout(dur: Duration) -> Deadline

New deadline from now + dur.

pub fn has_elapsed(self) -> bool

Returns true if the deadline was reached.

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

Returns the time left until the deadline is reached.

pub fn min(self, other: Deadline) -> Deadline

Returns the deadline further into the past or closest to now.

pub fn max(self, other: Deadline) -> Deadline

Returns the deadline further into the future.

Trait Implementations

impl Add<Duration> for Deadline

type Output = Deadline

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> Deadline

Performs the + operation.

impl AddAssign<Duration> for Deadline

fn add_assign(&mut self, rhs: Duration)

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<(), Error>

Formats the value using the given formatter.

impl Display for Deadline

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

Formats the value using the given formatter.

impl From<DInstant> for Deadline

fn from(value: DInstant) -> Deadline

Converts to this type from the input type.

impl From<Duration> for Deadline

fn from(value: Duration) -> Deadline

Converts to this type from the input type.

impl Hash for Deadline

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

where __H: Hasher,

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 IntoVar<Deadline> for DInstant

type Var = LocalVar<Deadline>

Variable type that will wrap the T value.

fn into_var(self) -> <DInstant as IntoVar<Deadline>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Deadline> for Duration

type Var = LocalVar<Deadline>

Variable type that will wrap the T value.

fn into_var(self) -> <Duration as IntoVar<Deadline>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

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

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: &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 Sub<Duration> for Deadline

type Output = Deadline

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> Deadline

Performs the - operation.

impl SubAssign<Duration> for Deadline

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.

impl Copy for Deadline

impl Eq for Deadline

impl IntoValue<Deadline> for DInstant

impl IntoValue<Deadline> for Duration

impl StructuralPartialEq for Deadline