Struct tokio::runtime::time::entry::TimerEntry

pub(crate) struct TimerEntry {
    driver: Handle,
    inner: UnsafeCell<TimerShared>,
    deadline: Instant,
    registered: bool,
    _m: PhantomPinned,
}

A timer entry.

This is the handle to a timer that is controlled by the requester of the timer. As this participates in intrusive data structures, it must be pinned before polling.

Fields

driver: Handle

Arc reference to the runtime handle. We can only free the driver after deregistering everything from their respective timer wheels.

inner: UnsafeCell<TimerShared>

Shared inner structure; this is part of an intrusive linked list, and therefore other references can exist to it while mutable references to Entry exist.

This is manipulated only under the inner mutex. TODO: Can we use loom cells for this?

deadline: Instant

Deadline for the timer. This is used to register on the first poll, as we can’t register prior to being pinned.

registered: bool

Whether the deadline has been registered.

_m: PhantomPinned

Ensure the type is !Unpin

Implementations

impl TimerEntry

pub(crate) fn new(handle: &Handle, deadline: Instant) -> Self

fn inner(&self) -> &TimerShared

pub(crate) fn deadline(&self) -> Instant

pub(crate) fn is_elapsed(&self) -> bool

pub(crate) fn cancel(self: Pin<&mut Self>)

Cancels and deregisters the timer. This operation is irreversible.

pub(crate) fn reset(self: Pin<&mut Self>, new_time: Instant, reregister: bool)

pub(crate) fn poll_elapsed( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Error>>

pub(crate) fn driver(&self) -> &Handle

Trait Implementations

impl Debug for TimerEntry

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

Formats the value using the given formatter.

impl Drop for TimerEntry

fn drop(&mut self)

Executes the destructor for this type.

impl Send for TimerEntry

impl Sync for TimerEntry