Struct Runtime

pub struct Runtime<Executor, Sender, Message> { /* private fields */ }

A batteries-included runtime of commands and subscriptions.

If you have an Executor, a Runtime can be leveraged to run any Command or Subscription and get notified of the results!

Implementations

impl<Executor, Sender, Message> Runtime<Executor, Sender, Message>

where Executor: Executor, Sender: Sink<Message, Error = SendError> + Unpin + MaybeSend + Clone + 'static, Message: MaybeSend + 'static,

pub fn new(executor: Executor, sender: Sender) -> Self

Creates a new empty Runtime.

You need to provide:

• an Executor to spawn futures
• a Sender implementing Sink to receive the results

pub fn enter<R>(&self, f: impl FnOnce() -> R) -> R

Runs the given closure inside the Executor of the Runtime.

See Executor::enter to learn more.

pub fn spawn(&mut self, future: BoxFuture<Message>)

Spawns a Future in the Runtime.

The resulting Message will be forwarded to the Sender of the Runtime.

pub fn run(&mut self, stream: BoxStream<Message>)

Runs a Stream in the Runtime until completion.

The resulting Messages will be forwarded to the Sender of the Runtime.

pub fn track( &mut self, recipes: impl IntoIterator<Item = Box<dyn Recipe<Output = Message>>>, )

Tracks a Subscription in the Runtime.

It will spawn new streams or close old ones as necessary! See Tracker::update to learn more about this!

pub fn broadcast(&mut self, event: Event)

Broadcasts an event to all the subscriptions currently alive in the Runtime.

See Tracker::broadcast to learn more.

Trait Implementations

impl<Executor: Debug, Sender: Debug, Message: Debug> Debug for Runtime<Executor, Sender, Message>

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

Formats the value using the given formatter.