Struct calloop::sources::timer::Timer

pub struct Timer {
    registration: Option<Registration>,
    deadline: Instant,
}

A timer event source

When registered to the event loop, it will trigger an event once its deadline is reached. If the deadline is in the past relative to the moment of its insertion in the event loop, the TImer will trigger an event as soon as the event loop is dispatched.

Fields

registration: Option<Registration>

deadline: Instant

Implementations

impl Timer

pub fn immediate() -> Timer

Create a timer that will fire immediately when inserted in the event loop

pub fn from_duration(duration: Duration) -> Timer

Create a timer that will fire after a given duration from now

pub fn from_deadline(deadline: Instant) -> Timer

Create a timer that will fire at a given instant

pub fn set_deadline(&mut self, deadline: Instant)

Changes the deadline of this timer to an Instant

If the Timer is currently registered in the event loop, it needs to be re-registered for this change to take effect.

pub fn set_duration(&mut self, duration: Duration)

Changes the deadline of this timer to a Duration from now

If the Timer is currently registered in the event loop, it needs to be re-registered for this change to take effect.

pub fn current_deadline(&self) -> Instant

Get the current deadline of this Timer

Trait Implementations

impl Debug for Timer

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

Formats the value using the given formatter.

impl EventSource for Timer

type Event = Instant

The type of events generated by your source.

type Metadata = ()

Some metadata of your event source

type Ret = TimeoutAction

The return type of the user callback

type Error = Error

The error type returned from process_events() (not the user callback!).

fn process_events<F>( &mut self, _: Readiness, token: Token, callback: F ) -> Result<PostAction, Self::Error>where F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Process any relevant events

fn register( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory ) -> Result<()>

Register yourself to this poll instance

fn reregister( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory ) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

fn pre_run<F>(&mut self, _callback: F) -> Result<()>where F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Notification that a polling session is going to start

fn post_run<F>(&mut self, _callback: F) -> Result<()>where F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Notification that the current polling session ended