Struct suspend_core::listen::Listener

pub struct Listener { /* fields omitted */ }

A structure providing thread parking and notification operations.

Implementations

impl Listener

pub fn new() -> Self

Create a new Listener instance.

pub fn lock(&self) -> Result<ListenerGuard<'_>, LockError>

Create a ListenerGuard from a reference to the Listener. This will fail with LockError::Contended if the Listener has already been locked.

pub fn lock_mut(&mut self) -> ListenerGuard<'_>

Create a ListenerGuard from a mutable reference to the Listener. This is more efficient than Listener::lock() because the type system ensures that no other references are in use.

pub fn notify(&self) -> bool

Notify the Listener instance. This method returns true if the state was not already set to notified.

pub fn notifier(&self) -> Notifier

Create a new Notifier instance associated with this Listener.

pub fn waker(&self) -> Waker

Create a new Waker instance associated with this Listener.

Trait Implementations

impl Debug for Listener

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

Formats the value using the given formatter.

impl Drop for Listener

pub fn drop(&mut self)

Executes the destructor for this type.