Trait CanonStateSubscriptions

pub trait CanonStateSubscriptions: Send + Sync {
    // Required method
    fn subscribe_to_canonical_state(&self) -> CanonStateNotifications;

    // Provided method
    fn canonical_state_stream(&self) -> CanonStateNotificationStream { ... }
}

A type that allows to register chain related event subscriptions.

Required Methods

fn subscribe_to_canonical_state(&self) -> CanonStateNotifications

Get notified when a new canonical chain was imported.

A canonical chain be one or more blocks, a reorg or a revert.

Provided Methods

fn canonical_state_stream(&self) -> CanonStateNotificationStream

Convenience method to get a stream of CanonStateNotification.

Implementations on Foreign Types

impl<'a, T: 'a + CanonStateSubscriptions + ?Sized> CanonStateSubscriptions for &'a T

where &'a T: Send + Sync,

fn subscribe_to_canonical_state(&self) -> CanonStateNotifications

fn canonical_state_stream(&self) -> CanonStateNotificationStream

impl<T: CanonStateSubscriptions + ?Sized> CanonStateSubscriptions for Arc<T>

where Arc<T>: Send + Sync,

fn subscribe_to_canonical_state(&self) -> CanonStateNotifications

fn canonical_state_stream(&self) -> CanonStateNotificationStream

Implementors

impl CanonStateSubscriptions for TestCanonStateSubscriptions

Available on crate feature test-utils only.