Struct bottles::queue::Queue

pub struct Queue<T> { /* fields omitted */ }

A Queue of messages which are expected to be delivered to the corresponding subscribers along with a reference to a shared context value.

The Queue achieves its goal by enqueueing the awaiting messages in order to dispatch them on demand by a call to the Queue::poll method, which accepts the shared context mutable reference.

Methods

impl<T> Queue<T>

pub fn new() -> Self

Creates a new Queue

pub fn register<M: 'static>(&mut self, dispatcher: &mut Dispatcher)

Registers a new message value type to be possible to subscriber to and dispatch.

This is analogous to the Dispatcher::register() method, but not only it registers the type in the provided dispatcher but also internally, to create a queue for the specified type.

pub fn subscribe<F, M>(&mut self, dispatcher: &mut Dispatcher, f: F) where
    F: FnMut(&mut T, Rc<M>) + 'static,
    M: 'static, 

Subscribes the provide closure which takes exactly 2 arguments: &mut T context value Rc<M> the expected message type.

This is analogous to the Dispatcher::subscribe(callback) method, but the provided callback will be called only when Queue::poll(&mut context) is called.

Implementation details

The subscriber provided to the underlying dispatcher is a simple closure which takes the message and puts it in the Queue's queue.

pub fn poll(&mut self, context: &mut T)

Dispatches all accumulated messages to the corresponding subscribers along with the provided mutable reference to a context value.