Struct Deadline

Source

pub struct Deadline(pub DInstant);

Expand description

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§

Source §

impl Deadline

Source

pub const ELAPSED: Deadline

Deadline that is always elapsed.

Source

pub const MAX: Deadline

Deadline that is practically never reached.

Source

pub fn timeout(dur: Duration) -> Deadline

New deadline from now + dur.

Source

pub fn has_elapsed(self) -> bool

Returns true if the deadline was reached.

Source

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

Returns the time left until the deadline is reached.

Source

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

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

Source

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

Returns the deadline further into the future.

Trait Implementations§

Source §

impl Add<Duration> for Deadline

Source §

type Output = Deadline

The resulting type after applying the + operator.

Source §

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

Performs the + operation. Read more

Source §

impl AddAssign<Duration> for Deadline

Source §

fn add_assign(&mut self, rhs: Duration)

Performs the += operation. Read more

Source §

impl Clone for Deadline

Source §

fn clone(&self) -> Deadline

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Deadline

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Deadline

Source §

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

Formats the value using the given formatter. Read more

Source §

impl From<DInstant> for Deadline

Source §

fn from(value: DInstant) -> Deadline

Converts to this type from the input type.

Source §

impl From<Duration> for Deadline

Source §

fn from(value: Duration) -> Deadline

Converts to this type from the input type.

Source §

impl Hash for Deadline

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl IntoVar<Deadline> for DInstant

Source §

type Var = LocalVar<Deadline>

Variable type that will wrap the T value. Read more

Source §

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

Converts the source value into a var.

Source §

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>
where Self: Sized,

Converts into BoxedVar<T>. Read more

Source §

impl Ord for Deadline

Source §

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for Deadline

Source §

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

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

1.0.0 · Source§

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

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

Source §

impl PartialOrd for Deadline

Source §

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

Source §

impl Sub<Duration> for Deadline

Source §

type Output = Deadline

The resulting type after applying the - operator.

Source §

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

Performs the - operation. Read more

Source §

impl SubAssign<Duration> for Deadline

Source §

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation. Read more

Source §

impl StructuralPartialEq for Deadline

Auto Trait Implementations§

§

impl Freeze for Deadline

§

impl RefUnwindSafe for Deadline

§

impl Send for Deadline

§

impl Sync for Deadline

§

impl Unpin for Deadline

§

impl UnwindSafe for Deadline

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> AnyVarValue for T
where T: VarValue,

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.

Source §

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.

Source §

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.

Source §

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

Source §

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source §

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §