Struct calloop::LoopHandle

pub struct LoopHandle<Data> { /* fields omitted */ }

An handle to an event loop

This handle allows you to insert new sources and idles in this event loop, it can be cloned, and it is possible to insert new sources from within a source callback.

Implementations

impl<Data> LoopHandle<Data>

pub fn insert_source<S, F>(
    &self,
    source: S,
    callback: F
) -> Result<Source<S>, InsertError<S>> where
    S: EventSource + 'static,
    F: FnMut(S::Event, &mut S::Metadata, &mut Data) -> S::Ret + 'static, 

Insert an new event source in the loop

The provided callback will be called during the dispatching cycles whenever the associated source generates events, see EventLoop::dispatch(..) for details.

pub fn insert_idle<F: FnOnce(&mut Data) + 'static>(&self, callback: F) -> Idle

Insert an idle callback

This callback will be called during a dispatching cycle when the event loop has finished processing all pending events from the sources and becomes idle.

pub fn with_source<S: EventSource + 'static, T, F: FnOnce(&mut S) -> T>(
    &self,
    source: &Source<S>,
    f: F
) -> T

Access this event source

This allows you to modify the event source without removing it from the event loop if it allows it.

Note that replacing it with an other using mem::replace or equivalent would not correctly update its registration and generate errors. Instead you should remove the source using the remove() method and then insert a new one.

Note: This cannot be done from within the callback of the same source.

pub fn enable<E: EventSource>(&self, source: &Source<E>) -> Result<()>

Enable this previously disabled event source

This previously disabled source will start generating events again.

Note: This cannot be done from within the callback of the same source.

pub fn update<E: EventSource>(&self, source: &Source<E>) -> Result<()>

Make this source update its registration

If after accessing the source you changed its parameters in a way that requires updating its registration.

Note: This cannot be done from within the callback of the same source.

pub fn disable<E: EventSource>(&self, source: &Source<E>) -> Result<()>

Disable this event source

The source remains in the event loop, but it’ll no longer generate events

Note: This cannot be done from within the callback of the same source.

pub fn remove<S: EventSource + 'static>(&self, source: Source<S>) -> S

Remove this source from the event loop

You are givent the EventSource back.

Note: This cannot be done from within the callback of the same source.

pub fn kill<S: EventSource + 'static>(&self, source: Source<S>)

Remove this event source from the event loop and drop it

The source is not given back to you but instead dropped

Note: This can be done from within the callback of the same source

Trait Implementations

impl<Data> Clone for LoopHandle<Data>

fn clone(&self) -> LoopHandle<Data>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.