Struct jsonrpc_pubsub::manager::SubscriptionManager[][src]

pub struct SubscriptionManager<I: IdProvider = RandomStringIdProvider> { /* fields omitted */ }

Subscriptions manager.

Takes care of assigning unique subscription ids and driving the sinks into completion.

Implementations

impl SubscriptionManager[src]

pub fn new(executor: TaskExecutor) -> Self[src]

Creates a new SubscriptionManager.

Uses RandomStringIdProvider as the ID provider.

impl<I: IdProvider> SubscriptionManager<I>[src]

pub fn with_id_provider(id_provider: I, executor: TaskExecutor) -> Self[src]

Creates a new SubscriptionManager with the specified ID provider.

pub fn executor(&self) -> &TaskExecutor[src]

Borrows the internal task executor.

This can be used to spawn additional tasks on the underlying event loop.

pub fn add<T, E, G, R, F>(
    &self,
    subscriber: Subscriber<T, E>,
    into_future: G
) -> SubscriptionId where
    G: FnOnce(Sink<T, E>) -> R,
    R: IntoFuture<Future = F, Item = (), Error = ()>,
    F: Future<Item = (), Error = ()> + Send + 'static, 
[src]

Creates new subscription for given subscriber.

Second parameter is a function that converts Subscriber Sink into a Future. This future will be driven to completion by the underlying event loop

pub fn cancel(&self, id: SubscriptionId) -> bool[src]

Cancel subscription.

Returns true if subscription existed or false otherwise.

impl<I: Default + IdProvider> SubscriptionManager<I>[src]

pub fn with_executor(executor: TaskExecutor) -> Self[src]

Creates a new SubscriptionManager.

Trait Implementations

impl<I: Clone + IdProvider> Clone for SubscriptionManager<I>[src]

Auto Trait Implementations

impl<I = RandomStringIdProvider> !RefUnwindSafe for SubscriptionManager<I>

impl<I> Send for SubscriptionManager<I> where
    I: Send

impl<I> Sync for SubscriptionManager<I> where
    I: Sync

impl<I> Unpin for SubscriptionManager<I> where
    I: Unpin

impl<I = RandomStringIdProvider> !UnwindSafe for SubscriptionManager<I>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 
[src]