Struct kaspa_utils::triggers::Listener

pub struct Listener { /* private fields */ }

A struct used to wait for a trigger event from a Trigger.

Can be waited on synchronously via Listener::wait or asynchronously thanks to the struct implementing Future.

The listener can be cloned and any amount of threads and tasks can wait for the same trigger at the same time.

Implementations

impl Listener

pub fn wait(&self)

Wait for this trigger synchronously.

Blocks the current thread until the corresponding Trigger is triggered. If the trigger has already been triggered at least once, this returns immediately.

pub fn is_triggered(&self) -> bool

Returns true if this trigger has been triggered.

Trait Implementations

impl Clone for Listener

fn clone(&self) -> Listener

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Listener

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

Formats the value using the given formatter.

impl Drop for Listener

fn drop(&mut self)

Executes the destructor for this type.

impl Future for Listener

type Output = ()

The type of value produced on completion.

fn poll( self: Pin<&mut Listener>, cx: &mut Context<'_> ) -> Poll<<Listener as Future>::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl Unpin for Listener