Struct nysa::Bus

pub struct Bus { /* fields omitted */ }

A bus for passing messages across threads.

Nysa buses are fully thread-safe, and thus, can be stored in static variables. The library provides a “default” bus in the module crate::global.

Implementations

impl Bus

pub fn new() -> Self

Creates a new bus.

pub fn push<T>(&self, message_data: T) where
    T: 'static + Send, 

Pushes a message with the given data onto the bus.

pub fn retrieve_all<'bus, T>(&'bus self) -> RetrieveAllRef<'bus, T> where
    T: 'static + Send, 

Retrieves all messages of the given type from the bus.

Note that the bus for the given message type is locked for the entire duration of this loop.

See also

• Bus::wait_for
• Bus::wait_for_timeout

pub fn wait_for<'bus, T>(&'bus self) -> Message<'bus, T> where
    T: 'static + Send, 

Blocks execution in the current thread indefinitely until a message of the provided type arrives on the bus.

Although the Rust style guidelines say otherwise, to prevent bugs and aid readability it’s best to always use the turbofish syntax over implicit type inference with this function, such that it’s immediately visible what type of message is being waited for.

See also

• Bus::retrieve_all
• Bus::wait_for_timeout

pub fn wait_for_timeout<'bus, T>(
    &'bus self,
    timeout: Duration
) -> Option<Message<'bus, T>> where
    T: 'static + Send, 

Blocks execution in the current thread until a message of the provided type arrives on the bus, or the given timeout is reached.

This function will block for the specified amount of time at most and resume execution normally. Otherwise it will block indefinitely.

Returns Some(data) if data was successfully fetched, or None if the timeout was reached.

See also

• Bus::retrieve_all
• Bus::wait_for