pubnub 0.7.0

PubNub SDK for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

//! # Events subscriber module.
//!
//! This module contains the [`Subscriber`] and [`MultiplexSubscriber`] traits
//! which is used by types to provide ability to subscribe for real-time events.

use crate::{
    core::{Deserializer, Transport},
    lib::alloc::vec::Vec,
    subscribe::{Subscription, SubscriptionOptions},
};

/// Trait representing a subscriber.
pub trait Subscriber<T: Transport + Send + Sync, D: Deserializer + Send + Sync> {
    /// Creates a new subscription with the specified options.
    ///
    /// # Arguments
    ///
    /// * `options` - The subscription options. Pass `None` if no specific
    ///   options should be applied.
    ///
    /// # Returns
    ///
    /// A [`Subscription`] object representing the newly created subscription to
    /// receiver's data stream events.
    fn subscription(&self, options: Option<Vec<SubscriptionOptions>>) -> Subscription<T, D>;
}