Struct event::EventQueue

pub struct EventQueue<R, E = IOError> {
    pub file: File,
    // some fields omitted
}

Fields

file: File

The file to read events from

Methods

impl<R, E> EventQueue<R, E> where
    E: From<IOError>, 

pub fn new() -> IOResult<EventQueue<R, E>>

Create a new event queue

pub fn set_default_callback<F>(&mut self, callback: F) where
    F: FnMut(Event) -> Result<Option<R>, E> + 'static, 

Set the default callback to be called if an event is produced by a FD not registered with add.

pub fn add<F: FnMut(Event) -> Result<Option<R>, E> + 'static>(
    &mut self,
    fd: RawFd,
    callback: F
) -> IOResult<usize>

Add a file to the event queue, calling a callback when an event occurs. Returns the event id it got, which can be used to remove or trigger this event.

The callback returns Ok(None) if it wishes to continue the event loop, or Ok(Some(R)) to break the event loop and return the value. Err can be used to allow the callback to return an error, and break the event loop.

pub fn remove(
    &mut self,
    id: usize
) -> IOResult<Option<Box<dyn FnMut(Event) -> Result<Option<R>, E>>>>

Remove a file from the event queue, returning its callback if found

pub fn trigger(&mut self, id: usize, event: Event) -> Result<Option<R>, E>

Send an event to a descriptor callback

pub fn trigger_all(&mut self, event: Event) -> Result<Vec<R>, E>

Send an event to all descriptor callbacks, useful for cleaning out buffers after init

pub fn run(&mut self) -> Result<R, E>

Process the event queue until a callback returns Some(R)