Struct calloop::Source

pub struct Source<E: EventSource> { /* fields omitted */ }

An event source that has been inserted into the event loop

This handle allows you to remove it, and possibly more interactions depending on the source kind that will be provided by the Deref implementation of this struct to the evented object.

Dropping this handle does not deregister this source from the event loop, but will drop the wrapped EventSource, maybe rendering it inert depending on its implementation.

Methods

impl<E: EventSource> Source<E>

pub fn reregister(&self) -> Result<()>

Refresh the registration of this event source to the loop

This can be necessary if the evented object provides methods to change its behavior. Its documentation should inform you of the need for re-registration.

pub fn remove(self) -> E

Remove this source from the event loop

You are given the evented object back.

Trait Implementations

impl<E: EventSource> Deref for Source<E>

type Target = E

The resulting type after dereferencing.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref(&self) -> &E

Dereferences the value.

impl<E: EventSource> DerefMut for Source<E>

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn deref_mut(&mut self) -> &mut E

Mutably dereferences the value.