Struct Event

pub struct Event { /* private fields */ }

Implementations

impl Event

pub fn new<InnerFn>(_description: impl FnOnce() -> InnerFn) -> Self

where InnerFn: Fn() -> String + Sync + Send + 'static,

See [event_listener::Event::new]. May attach a description that may optionally be read later.

This confusingly takes a closure (FnOnce) that returns a nested closure (Fn).

When hanging_detection is disabled, description is never called.

When hanging_detection is enabled, the outer closure is called immediately. The outer closure can have an ephemeral lifetime. The inner closure must be 'static, but is called only when the description is actually read.

The outer closure allows avoiding extra lookups (e.g. task type info) that may be needed to capture information needed for constructing (moving into) the inner closure.

pub fn listen(&self) -> EventListener

See [event_listener::Event::listen].

pub fn listen_with_note<InnerFn>( &self, _note: impl FnOnce() -> InnerFn, ) -> EventListener

where InnerFn: Fn() -> String + Sync + Send + 'static,

See [event_listener::Event::listen]. May attach a note that may optionally be read later.

This confusingly takes a closure (FnOnce) that returns a nested closure (Fn).

When hanging_detection is disabled, note is never called.

When hanging_detection is enabled, the outer closure is called immediately. The outer closure can have an ephemeral lifetime. The inner closer must be 'static, but is called only when the note is actually read.

The outer closure allow avoiding extra lookups (e.g. task type info) that may be needed to capture information needed for constructing (moving into) the inner closure.

pub fn take(&mut self) -> Event

pulls out the event listener, leaving a new, empty event in its place.

impl Event

pub fn notify(&self, n: usize)

see [event_listener::Event::notify]

Trait Implementations

impl Debug for Event

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

Formats the value using the given formatter.