Struct zng_app::timer::DeadlineHandle

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

Represents a on_deadline handler.

Drop all clones of this handle to cancel the timer, or call perm to drop the handle without cancelling the timer.

Implementations

impl DeadlineHandle

pub fn dummy() -> DeadlineHandle

Create a handle to nothing, the handle always in the canceled state.

Note that Option<DeadlineHandle> takes up the same space as DeadlineHandle and avoids an allocation.

pub fn perm(self)

Drops the handle but does not drop the handler closure.

The handler closure will be dropped after it is executed or when the app exits.

pub fn is_permanent(&self) -> bool

If perm was called in another handle.

If true the closure will be dropped when it executes, when the app exits or if cancel is called.

pub fn cancel(self)

Drops the handle and forces the handler to drop.

If the deadline has not been reached the handler will not be called, and will drop in the next app update.

pub fn deadline(&self) -> Deadline

The timeout deadline.

The handler is called once when this deadline is reached.

pub fn has_executed(&self) -> bool

If the handler has executed. The handler executes once when the deadline is reached.

pub fn is_canceled(&self) -> bool

If the timeout handler will never execute. Returns true if cancel was called before the handler could execute.

pub fn downgrade(&self) -> WeakDeadlineHandle

Create a weak handle to the deadline.

Trait Implementations

impl Clone for DeadlineHandle

fn clone(&self) -> DeadlineHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeadlineHandle

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

Formats the value using the given formatter.

impl Hash for DeadlineHandle

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 PartialEq for DeadlineHandle

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

impl StructuralPartialEq for DeadlineHandle