Struct calloop::Dispatcher

pub struct Dispatcher<'a, S, Data>(Rc<dyn ErasedDispatcher<'a, S, Data> + 'a>);

An event source with its callback.

The Dispatcher can be registered in an event loop. Use the as_source_{ref,mut} functions to interact with the event source. Use into_source_inner to get the event source back.

Tuple Fields

0: Rc<dyn ErasedDispatcher<'a, S, Data> + 'a>

Implementations

impl<'a, S, Data> Dispatcher<'a, S, Data>

where S: EventSource + 'a,

pub fn new<F>(source: S, callback: F) -> Self

where F: FnMut(S::Event, &mut S::Metadata, &mut Data) -> S::Ret + 'a,

Builds a dispatcher.

The resulting Dispatcher

pub fn as_source_ref(&self) -> Ref<'_, S>

Returns an immutable reference to the event source.

Panics

Has the same semantics as RefCell::borrow().

The dispatcher being mutably borrowed while its events are dispatched, this method will panic if invoked from within the associated dispatching closure.

pub fn as_source_mut(&self) -> RefMut<'_, S>

Returns a mutable reference to the event source.

Panics

Has the same semantics as RefCell::borrow_mut().

The dispatcher being mutably borrowed while its events are dispatched, this method will panic if invoked from within the associated dispatching closure.

pub fn into_source_inner(self) -> S

Consumes the Dispatcher and returns the inner event source.

Panics

Panics if the Dispatcher is still registered.

pub(crate) fn clone_as_event_dispatcher( &self, ) -> Rc<dyn EventDispatcher<Data> + 'a>

Trait Implementations

impl<'a, S, Data> Clone for Dispatcher<'a, S, Data>

fn clone(&self) -> Dispatcher<'a, S, Data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S, Data> Debug for Dispatcher<'a, S, Data>

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

Formats the value using the given formatter.