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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

//! This module contains the task spawning trait used in the PubNub client.
//!
//! The [`Spawner`] trait is used to spawn async tasks in work of the PubNub
//! client.

use crate::lib::{
    alloc::{
        fmt::{Debug, Formatter, Result},
        sync::Arc,
    },
    core::future::Future,
};
use futures::future::{BoxFuture, FutureExt};

/// PubNub spawner trait.
///
/// This trait is used to spawn async tasks in work of the PubNub client.
/// It is used to spawn tasks for the proper work of some features
/// that require async tasks to be spawned.
///
/// # Examples
/// ```
/// use pubnub::core::{Runtime, PubNubError};
/// use std::future::Future;
///
/// #[derive(Clone)]
/// struct MyRuntime;
///
/// #[async_trait::async_trait]
/// impl Runtime for MyRuntime {
///    fn spawn<R>(&self, future: impl Future<Output = R> + Send + 'static) {
///       // spawn the Future
///       // e.g. tokio::spawn(future);
///    }
///    
///    async fn sleep(self, _delay: u64) {
///       // e.g. tokio::time::sleep(tokio::time::Duration::from_secs(delay)).await
///    }
///    
///    async fn sleep_microseconds(self, _delay: u64) {
///       // e.g. tokio::time::sleep(tokio::time::Duration::from_micros(delay)).await
///    }
/// }
/// ```
#[async_trait::async_trait]
pub trait Runtime: Clone + Send {
    /// Spawn a task.
    ///
    /// This method is used to spawn a task.
    fn spawn<R>(&self, future: impl Future<Output = R> + Send + 'static)
    where
        R: Send + 'static;

    /// Put current task to "sleep".
    ///
    /// Sleep current task for specified amount of time (in seconds).
    async fn sleep(self, delay: u64);

    /// Put current task to "sleep".
    ///
    /// Sleep current task for specified amount of time (in microseconds).
    async fn sleep_microseconds(self, delay: u64);
}

#[derive(Clone)]
pub(crate) struct RuntimeSupport {
    spawner: Arc<dyn Fn(BoxFuture<'static, ()>) + Send + Sync>,
    sleeper: Arc<dyn Fn(u64) -> BoxFuture<'static, ()> + Send + Sync>,
    sleeper_microseconds: Arc<dyn Fn(u64) -> BoxFuture<'static, ()> + Send + Sync>,
}

impl RuntimeSupport {
    pub fn new<R>(runtime: Arc<R>) -> Self
    where
        R: Runtime + Copy + Send + Sync + 'static,
    {
        let spawn_runtime = runtime.clone();
        let sleep_runtime = runtime.clone();
        let sleep_microseconds_runtime = runtime.clone();

        Self {
            sleeper: Arc::new(move |delay| sleep_runtime.sleep(delay).boxed()),
            sleeper_microseconds: Arc::new(move |delay| {
                sleep_microseconds_runtime.sleep_microseconds(delay).boxed()
            }),
            spawner: Arc::new(Box::new(move |future| {
                spawn_runtime.spawn(future);
            })),
        }
    }
}

#[async_trait::async_trait]
impl Runtime for RuntimeSupport {
    fn spawn<R>(&self, future: impl Future<Output = R> + Send + 'static)
    where
        R: Send + 'static,
    {
        (self.spawner.clone())(
            async move {
                future.await;
            }
            .boxed(),
        );
    }

    async fn sleep(self, delay: u64) {
        (self.sleeper)(delay).await
    }

    async fn sleep_microseconds(self, delay: u64) {
        (self.sleeper_microseconds)(delay).await
    }
}

impl Debug for RuntimeSupport {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        write!(f, "RuntimeSupport {{}}")
    }
}