Struct Signal

pub struct Signal { /* private fields */ }

The signal type that is passed to the thread.

The thread must check the signal periodically for whether it should terminate or not. If the signal notifies the thread to stop, it should exit as fast as possible.

Implementations

impl Signal

pub fn should_continue(&self) -> bool

Check whether the thread this signal was passed to is allowed to continue

Opposite of should_stop

pub fn should_stop(&self) -> bool

Check whether the thread this signal was passed to should stop now. If this function returns true, the thread should exit as soon as possible.

Warning: Once this function returned true, due to current limitations, it might not return true when called again. Once true is returned, exit without checking the signal again.

Trait Implementations

impl Debug for Signal

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

Formats the value using the given formatter.