Struct Signaler

pub struct Signaler<S> { /* private fields */ }

A signaler, main type for signaling

Implementations

impl<S> Signaler<S>

pub fn new() -> Signaler<S>

Create a new signaler for given signal type

pub fn register<F: FnMut(&S) + 'static>(&self, f: F) -> SignalToken

Register a new callback to this signaler

This method returns a SignalToken, which you must keep as long as you need your callback to remain in place. Dropping it will disable and free your callback. If you don’t plan to ever disable your callback, see SignalToken::leak().

If you register a callback from within a callback of the same Signaler, the new callback will only be inserted after the current signal is completely delivered, and thus will not receive it.

pub fn signal(&self, signal: S)

Signal the callbacks

All registered callbacks will be invoked with a reference to the value you provide here, after which that value will be dropped.

If this method is invoked from within a callback of the same Signaler, its signalling will be delayed until the current signal is completely delivered and this method will return immediately.

Trait Implementations

impl<S> Clone for Signaler<S>

fn clone(&self) -> Signaler<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Signaler<S>

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

Formats the value using the given formatter.

impl<S> Default for Signaler<S>

fn default() -> Self

Returns the “default value” for a type.