Struct evident::subscription::Subscription

pub struct Subscription<'p, K, M, T, F>where
    K: Id + CaptureControl,
    M: Msg,
    T: EventEntry<K, M>,
    F: Filter<K, M>,{ /* private fields */ }

Subscription that is returned when subscribing to events captured by an EvidentPublisher.

[req:subs]

Implementations

impl<'p, K, M, T, F> Subscription<'p, K, M, T, F>where K: Id + CaptureControl, M: Msg, T: EventEntry<K, M>, F: Filter<K, M>,

pub fn get_receiver(&self) -> &Receiver<Arc<Event<K, M, T>>>

Get the Receiver of the subscription channel.

pub fn unsubscribe(self)

Unsubscribes this subscription.

pub fn unsubscribe_id(&mut self, id: K) -> Result<(), SubscriptionError<K>>

Unsubscribes from the given event-ID.

Note: Only possible for subscriptions to specific IDs.

Arguments

• id … Event-ID the subscription should be unsubscribed from

Possible Errors

• SubscriptionError::IdNotSubscribed … If athe given ID was not subscribed,
• SubscriptionError::UnsubscribeWouldDeleteSubscription … If the Subscription would not be subscribed to any ID afterwards
• SubscriptionError::AllEventsSubscriptionNotModifiable … If the Subscription was created to receive all events

pub fn unsubscribe_many( &mut self, ids: Vec<K> ) -> Result<(), SubscriptionError<K>>

Unsubscribes from the given list of event-IDs.

Note: Only possible for subscriptions to specific IDs.

Arguments

• ids … List of event-IDs the subscription should be unsubscribed from

Possible Errors

• SubscriptionError::IdNotSubscribed … If any of the given IDs was not subscribed,
• SubscriptionError::UnsubscribeWouldDeleteSubscription … If the Subscription would not be subscribed to any ID afterwards
• SubscriptionError::AllEventsSubscriptionNotModifiable … If the Subscription was created to receive all events

pub fn subscribe_id(&mut self, id: K) -> Result<(), SubscriptionError<K>>

Subscribes to the given event-ID.

Note: Only possible for subscriptions to specific IDs.

Arguments

• id … Event-ID that should be added to the subscribed IDs by the Subscription

Possible Errors

• SubscriptionError::IdAlreadySubscribed … If the given ID is already subscribed,
• SubscriptionError::CouldNotAccessPublisher … If the Subscription has no connection to the EvidentPublisher
• SubscriptionError::NoSubscriptionChannelAvailable … If the EvidentPublisher has no stored channel to this Subscription
• SubscriptionError::AllEventsSubscriptionNotModifiable … If the Subscription was created to receive all events

[req:subs.specific.one]

pub fn subscribe_many( &mut self, ids: Vec<K> ) -> Result<(), SubscriptionError<K>>

Subscribes to the given list of event-IDs.

Note: Only possible for subscriptions to specific IDs.

Arguments

• ids … List of event-IDs that should be added to the subscribed IDs by the Subscription

Possible Errors

• SubscriptionError::IdAlreadySubscribed … If one of the given IDs is already subscribed,
• SubscriptionError::CouldNotAccessPublisher … If the Subscription has no connection to the EvidentPublisher
• SubscriptionError::NoSubscriptionChannelAvailable … If the EvidentPublisher has no stored channel to this Subscription
• SubscriptionError::AllEventsSubscriptionNotModifiable … If the Subscription was created to receive all events

[req:subs.specific.mult]

Trait Implementations

impl<'p, K, M, T, F> Drop for Subscription<'p, K, M, T, F>where K: Id + CaptureControl, M: Msg, T: EventEntry<K, M>, F: Filter<K, M>,

fn drop(&mut self)

Executes the destructor for this type.

impl<'p, K, M, T, F> Hash for Subscription<'p, K, M, T, F>where K: Id + CaptureControl, M: Msg, T: EventEntry<K, M>, F: Filter<K, M>,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'p, K, M, T, F> PartialEq<Subscription<'p, K, M, T, F>> for Subscription<'p, K, M, T, F>where K: Id + CaptureControl, M: Msg, T: EventEntry<K, M>, F: Filter<K, M>,

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'p, K, M, T, F> Eq for Subscription<'p, K, M, T, F>where K: Id + CaptureControl, M: Msg, T: EventEntry<K, M>, F: Filter<K, M>,