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

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

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<Option<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§

source§

impl TimerEntry

source

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

source

fn is_inner_init(&self) -> bool

source

fn inner(&self) -> &TimerShared

source

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

source

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

source

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

Cancels and deregisters the timer. This operation is irreversible.

source

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

source

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

source

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

Trait Implementations§

source§

impl Debug for TimerEntry

source§

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

Formats the value using the given formatter. Read more
source§

impl Drop for TimerEntry

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Send for TimerEntry

source§

impl Sync for TimerEntry

Auto Trait Implementations§

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> 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> 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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.