Struct Signal 

pub struct Signal { /* private fields */ }

See the module docs.

Implementations

impl Signal

pub const fn new() -> Self

Create a new, unfired signal.

pub fn signal(&self)

External/ISR side: latch the signal and wake the registered waiter, if any. Safe to call from Handler mode / an interrupt, from either hart on an SMP build, or from plain task code.

pub fn try_take(&self) -> bool

Non-blocking consume: clears and returns whether the signal had fired. Usable from a preemptive task, or from boot code before the scheduler starts.

pub fn reset(&self)

Clear a stale latch. Drivers must call this before arming hardware for a new transaction — otherwise a signal left over from a previous, already-completed (or cancelled) transaction would make the next wait() return immediately with nothing to report.

pub fn wait(&self) -> Wait<'_>

Cooperative-tier wait: yields the task until Signal::signal is called (or returns immediately if it already latched).

Panics

Panics if polled outside of a task context (i.e. not from within the executor’s poll of a #[rivet::task]).

Trait Implementations

impl Default for Signal

fn default() -> Self

Returns the “default value” for a type.

impl Sync for Signal