yupdates 0.0.2

Yupdates Rust SDK
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

use crate::api::{ping_with_args, PingResponse};
use crate::errors::Result;
use crate::{api_token, env_or_default_url};

// ─────────────────────────────────────────────────────────────────────────────────────────────────
// ASYNC CLIENT
// ─────────────────────────────────────────────────────────────────────────────────────────────────

/// Create an [AsyncYupdatesClient] instance using the default configuration sources.
pub fn new_async_client() -> Result<AsyncYupdatesClient> {
    let base_url = env_or_default_url()?;
    let token = api_token()?;
    Ok(AsyncYupdatesClient { base_url, token })
}

/// Wraps everything needed to make async calls to the API
pub struct AsyncYupdatesClient {
    pub base_url: String,
    pub token: String,
}

/// Rust does not support async traits, but we 'implement' [YupdatesV0]
impl AsyncYupdatesClient {
    pub async fn ping(&self) -> Result<PingResponse> {
        ping_with_args(&self.base_url, &self.token).await
    }
}

// ─────────────────────────────────────────────────────────────────────────────────────────────────
// SYNC CLIENT
// ─────────────────────────────────────────────────────────────────────────────────────────────────

#[cfg(feature = "sync_client")]
pub mod sync {
    use crate::api::{PingResponse, YupdatesV0};
    use crate::clients::AsyncYupdatesClient;
    use crate::errors::{Error, Result};
    use crate::{api_token, env_or_default_url, Kind};
    use tokio::runtime::Runtime;

    /// Wraps everything needed to make sync calls to the API, encapsulating a Tokio runtime.
    ///
    /// This allows you to make one-off CLIs pretty easily. You can list just `yupdates` as a
    /// dependency and write code like `new_sync_client()?.ping()`.
    pub struct SyncYupdatesClient {
        pub client: AsyncYupdatesClient,
        pub rt: Runtime,
    }

    /// Create a [SyncYupdatesClient] instance using the default configuration sources.
    pub fn new_sync_client() -> Result<SyncYupdatesClient> {
        let base_url = env_or_default_url()?;
        let token = api_token()?;
        let client = AsyncYupdatesClient { base_url, token };
        let rt = match Runtime::new() {
            Ok(rt) => rt,
            Err(e) => {
                return Err(Error {
                    kind: Kind::Config(format!("Could not create Tokio runtime: {}", e)),
                })
            }
        };
        Ok(SyncYupdatesClient { client, rt })
    }

    impl YupdatesV0 for SyncYupdatesClient {
        fn ping(&self) -> Result<PingResponse> {
            self.rt.block_on(self.client.ping())
        }
    }
}