Struct gaea::Timers

pub struct Timers { /* fields omitted */ }

Timer readiness queue.

Polling this event source never returns an error.

Examples

use std::time::Instant;

use gaea::{Event, Timers, Ready, event, poll};

let mut timers = Timers::new();
let mut events = Vec::new();

// Add a deadline, to trigger an event immediately.
let id = event::Id(0);
timers.add_deadline(id, Instant::now());

// Now we poll for events. Note that this is safe to unwrap as polling
// `Timers` never returns an error.
poll::<_, ()>(&mut [&mut timers], &mut events, None).unwrap();

assert_eq!(events.get(0), Some(&Event::new(id, Ready::TIMER)));

Methods

impl Timers

pub fn new() -> Timers

Create a new time event source.

pub fn add_deadline(&mut self, id: Id, deadline: Instant)

Add a new deadline.

This will cause an event to trigger after the deadline has passed with the Ready::TIMER readiness and provided id.

pub fn add_timeout(&mut self, id: Id, timeout: Duration)

Add a new timeout.

This is the same as add_deadline, but then using a Duration, see add_deadline for more information.

pub fn remove_deadline(&mut self, id: Id)

Remove a previously added deadline.

Notes

Removing a deadline is a costly operation. For better performance it is advised to not bother with removing and instead ignore the event when it comes up.

Trait Implementations

impl<ES, E> Source<ES, E> for Timers where
    ES: Sink, 

fn max_timeout(&self) -> Option<Duration>

The duration until the next event will be available.

fn poll(&mut self, event_sink: &mut ES) -> Result<(), E>

Poll for readiness events.

fn blocking_poll(
    &mut self,
    event_sink: &mut ES,
    timeout: Option<Duration>
) -> Result<(), E>

A blocking poll for readiness events.

impl Default for Timers

fn default() -> Timers

Returns the "default value" for a type.

impl Debug for Timers

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

Formats the value using the given formatter.