Struct gaea::Queue

pub struct Queue { /* fields omitted */ }

User space readiness queue.

A simple, single threaded user space readiness event queue. This implements event::Source which can be used to poll for readiness events.

Polling this event source never returns an error.

Examples

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

let mut queue = Queue::new();
let mut events = Vec::new();

// Add a new event.
let event = Event::new(event::Id(0), Ready::READABLE);
queue.add(event);

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

assert_eq!(events.get(0), Some(&event));

Methods

impl Queue

pub fn new() -> Queue

Create a new user space readiness event queue.

pub fn add(&mut self, event: Event)

Add a new readiness event.

Trait Implementations

impl<ES, E> Source<ES, E> for Queue 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 Queue

fn default() -> Queue

Returns the "default value" for a type.

impl Debug for Queue

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

Formats the value using the given formatter.