Struct Subscription

pub struct Subscription<M: Message> { /* private fields */ }

A type which is used for receiving messages of a specific type from the message broker.

Implementations

impl<M: Message> Subscription<M>

pub fn unregistered() -> Self

Creates a new Subscription which is not registered in any message broker and therefore can’t be used for receiving messages.

Examples found in repository

examples/simple.rs (line 41)

    fn new() -> Self {
        Self {
            sub: Subscription::unregistered(),
        }
    }

pub fn new(msg_broker: Arc<dyn MessageBroker>) -> Self

Creates a new Subscription which is registered in the given message broker.

pub fn recv_message(&self) -> Option<Arc<M>>

Receives one message if there is any.

pub fn process_messages<F: FnMut(Arc<M>)>(&self, f: F)

Processes all pending messages by calling the given function on each one.

Trait Implementations

impl<M: Message> Default for Subscription<M>

fn default() -> Self

Returns the “default value” for a type.

impl<M: Message> Drop for Subscription<M>

fn drop(&mut self)

Executes the destructor for this type.

impl<M: Message> ErasedSubscription for Subscription<M>

fn message_broker(&self) -> Option<Arc<dyn MessageBroker>>

Returns a message broker which sends messages to this subscription.

fn is_registered(&self) -> bool

Returns if the subscription is registered.

fn is_active(&self) -> bool

Returns if the subscription is active.

fn register( &mut self, msg_broker: Arc<dyn MessageBroker>, ) -> Result<(), SubscriptionError>

Registers the subscription in the given message broker.

fn unregister(&mut self) -> Result<(), SubscriptionError>

Unregisters the subscription in the given message broker.

fn activate(&self) -> Result<(), SubscriptionError>

Activates the subscription if it was deactivated before.

fn deactivate(&self) -> Result<(), SubscriptionError>

Dectivates the subscription, in other words temporary makes it stop receiving messages.

fn recv_message(&self) -> Option<Arc<dyn Message>>

Receives one message if there is any.

fn message_iter(&self) -> MessageIter<'_>

Returns an iterator that will attempt to yield all pending messages.

fn process_messages<'f>(&self, f: Box<dyn ErasedMessageHandler + 'f>)

Processes all pending messages by calling the given function on each one.