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

//! # Transport module
//!
//! This module contains the [`Transport`] trait and the [`TransportRequest`]
//! and [`TransportResponse`] types.
//!
//! You can implement this trait for your own types, or use one of the provided
//! features to use a transport library.
//!
//! [`PubNub API`]: https://www.pubnub.com/docs

use super::{transport_response::TransportResponse, PubNubError, TransportRequest};
use crate::lib::alloc::boxed::Box;

/// The default base URL for the [`PubNub API`].
/// This is used for the transport layer.
///
/// Use it when you implement the [`Transport`] trait without any proxy.
///
/// [`PubNub API`]: https://www.pubnub.com/docs
pub const PUBNUB_DEFAULT_BASE_URL: &str = "https://ps.pndsn.com";

/// This trait is used to send requests to the [`PubNub API`].
///
/// You can implement this trait for your own types, or use one of the provided
/// features to use a transport library.
///
/// # Examples
/// ```
/// use pubnub::core::{Transport, TransportRequest, TransportResponse, PubNubError};
///
/// struct MyTransport;
///
/// #[async_trait::async_trait]
/// impl Transport for MyTransport {
///    async fn send(&self, req: TransportRequest) -> Result<TransportResponse, PubNubError> {
///         // Send your request here
///
///         Ok(TransportResponse::default())
///    }
/// }
/// ```
///
/// [`PubNub API`]: https://www.pubnub.com/docs
#[cfg_attr(not(target_arch = "wasm32"), async_trait::async_trait)]
#[cfg_attr(target_arch = "wasm32", async_trait::async_trait(?Send))]
pub trait Transport: Send + Sync {
    /// Send a request to the [`PubNub API`].
    ///
    /// # Errors
    /// Should return an [`PubNubError::Transport`] if the request cannot be
    /// sent.
    ///
    /// [`PubNub API`]: https://www.pubnub.com/docs
    async fn send(&self, req: TransportRequest) -> Result<TransportResponse, PubNubError>;
}

#[cfg(feature = "blocking")]
pub mod blocking {
    //! # Blocking transport module
    //!
    //! This module contains the [`Transport`] trait and the
    //! [`TransportRequest`] and [`TransportResponse`] types.
    //!
    //! You can implement this trait for your own types, or use one of the
    //! provided features to use a transport library.
    //!
    //! This trait is used for blocking requests.
    //!
    //! [`PubNub API`]: https://www.pubnub.com/docs

    use crate::core::{PubNubError, TransportRequest, TransportResponse};

    /// This trait is used to send requests to the [`PubNub API`].
    ///
    /// You can implement this trait for your own types, or use one of the
    /// provided features to use a transport library.
    ///
    /// This trait is used for blocking requests.
    ///
    /// # Examples
    /// ```
    /// use pubnub::core::{blocking::Transport, TransportRequest, TransportResponse, PubNubError};
    ///
    /// struct MyTransport;
    ///
    /// impl Transport for MyTransport {
    ///    fn send(&self, req: TransportRequest) -> Result<TransportResponse, PubNubError> {
    ///         // Send your request here
    ///
    ///         Ok(TransportResponse::default())
    ///    }
    /// }
    /// ```
    ///
    /// [`PubNub API`]: https://www.pubnub.com/docs
    pub trait Transport {
        /// Send a request to the [`PubNub API`].
        ///
        /// # Errors
        /// Should return an [`PubNubError::Transport`] if the request cannot be
        /// sent.
        ///
        /// [`PubNub API`]: https://www.pubnub.com/docs
        fn send(&self, req: TransportRequest) -> Result<TransportResponse, PubNubError>;
    }
}