Struct calloop::loop_logic::LoopSignal

pub struct LoopSignal {
    signal: Arc<Signals>,
    notifier: Notifier,
}

A signal that can be shared between thread to stop or wakeup a running event loop

Fields

signal: Arc<Signals>

notifier: Notifier

Implementations

impl LoopSignal

pub fn stop(&self)

Stop the event loop

Once this method is called, the next time the event loop has finished waiting for events, it will return rather than starting to wait again.

This is only useful if you are using the EventLoop::run() method.

pub fn wakeup(&self)

Wake up the event loop

This sends a dummy event to the event loop to simulate the reception of an event, making the wait return early. Called after stop(), this ensures the event loop will terminate quickly if you specified a long timeout (or no timeout at all) to the dispatch or run method.

Trait Implementations

impl Clone for LoopSignal

fn clone(&self) -> LoopSignal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoopSignal

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

Formats the value using the given formatter.