Struct Trigger

pub struct Trigger { /* private fields */ }

re-exports triggered crate as well as two wrappers SingleTrigger and ReqRespTrigger A struct used to trigger Listeners it is paired with.

Can be cloned to create multiple instances that all trigger the same listeners.

Implementations

impl Trigger

pub fn trigger(&self)

Trigger all Listeners paired with this trigger.

Makes all listeners currently blocked in Listener::wait return, and all that is being awaited finish.

Calling this method only does anything the first time. Any subsequent trigger call to the same instance or a clone thereof does nothing, it has already been triggered. Any listener waiting on the trigger after it has been triggered will just return instantly.

This method is safe to call from both async and sync code. It’s not an async function, but it always finishes very fast.

pub fn is_triggered(&self) -> bool

Returns true if this trigger has been triggered.

Trait Implementations

impl Clone for Trigger

fn clone(&self) -> Trigger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trigger

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

Formats the value using the given formatter.

impl Unpin for Trigger