Struct sc_utils::pubsub::Hub

source ·
pub struct Hub<M, R> { /* private fields */ }
Expand description

A subscription hub.

Does the subscription and dispatch. The exact subscription and routing behaviour is to be implemented by the Registry (of type R). The Hub under the hood uses the channel defined in crate::mpsc module.

Implementations§

source§

impl<M, R> Hub<M, R>where R: Unsubscribe,

source

pub fn map_registry_for_tests<MapF, Ret>(&self, map: MapF) -> Retwhere MapF: FnOnce(&R) -> Ret,

Provide access to the registry (for test purposes).

source§

impl<M, R> Hub<M, R>

source

pub fn new(tracing_key: &'static str) -> Selfwhere R: Default,

Create a new instance of Hub (with default value for the Registry).

source

pub fn new_with_registry(tracing_key: &'static str, registry: R) -> Self

Create a new instance of Hub over the initialized Registry.

source

pub fn subscribe<K>( &self, subs_key: K, queue_size_warning: i64 ) -> Receiver<M, R>where R: Subscribe<K> + Unsubscribe,

Subscribe to this Hub using the subs_key: K.

A subscription with a key K is possible if the Registry implements Subscribe<K>.

source

pub fn send<Trigger>(&self, trigger: Trigger) -> <R as Dispatch<Trigger>>::Retwhere R: Dispatch<Trigger, Item = M>,

Send the message produced with Trigger.

This is possible if the registry implements Dispatch<Trigger, Item = M>.

Trait Implementations§

source§

impl<M, R> Clone for Hub<M, R>

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<M: Debug, R: Debug> Debug for Hub<M, R>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M, R> !RefUnwindSafe for Hub<M, R>

§

impl<M, R> Send for Hub<M, R>where M: Send, R: Send,

§

impl<M, R> Sync for Hub<M, R>where M: Send, R: Send,

§

impl<M, R> Unpin for Hub<M, R>

§

impl<M, R> !UnwindSafe for Hub<M, R>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.