Struct Signal

pub struct Signal { /* private fields */ }

A Signal represents listens for a pulse to occur in the system. A Signal has one of three states. Pending, Pulsed, or Errored. Pending means the pulse has not fired, but still exists. Pulsed meaning the pulse has fired, and no longer exists. Errored means the pulse was dropped without firing. This normally means a programming error of some sort.

Implementations

impl Signal

pub fn new() -> (Signal, Pulse)

Create a Signal and a Pulse that are associated.

pub fn pulsed() -> Signal

Create a signal that is already pulsed

pub fn state(&self) -> SignalState

Read out the state of the Signal

pub fn is_pending(&self) -> bool

Check to see if the signal is pending. A signal

pub fn id(&self) -> usize

This is a unique id that can be used to identify the signal from others See Select for how this api is useful.

pub fn wait(self) -> Result<(), WaitError>

Block the current thread until a pulse is ready. This will block indefinably if the pulse never fires.

pub fn wait_timeout_ms(self, ms: u32) -> Result<(), TimeoutError>

Block until either the pulse is sent, or the timeout is reached

pub fn callback<F>(self, cb: F)

where F: FnOnce() + 'static,

Trait Implementations

impl Clone for Signal

fn clone(&self) -> Signal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signal

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

Formats the value using the given formatter.

impl Drop for Signal

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawPtr for Signal

unsafe fn from_raw(ptr: *mut ()) -> Signal

impl IntoRawPtr for Signal

unsafe fn into_raw(self) -> *mut ()

impl Send for Signal

impl Sync for Signal