alpha_vantage 0.11.0

Rust Wrapper/Crate built for AlphaVantage API
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

use serde::de::DeserializeOwned;

use crate::api::ApiClient;
use crate::error::Result;

/// Builder to create new Custom Struct
pub struct CustomBuilder<'a> {
    api_client: &'a ApiClient,
    function: &'a str,
    extras: Vec<(&'a str, &'a str)>,
}

impl<'a> CustomBuilder<'a> {
    /// Create new `CustomBuilder` from `APIClient`
    #[must_use]
    pub fn new(api_client: &'a ApiClient, function: &'a str) -> Self {
        Self {
            api_client,
            function,
            extras: vec![],
        }
    }

    /// Add extra parameter to url
    pub fn extra_params(&mut self, key: &'a str, value: &'a str) -> &mut Self {
        self.extras.push((key, value));
        self
    }

    fn create_url(&self) -> String {
        let mut path = format!("query?function={}", self.function);
        for (key, value) in &self.extras {
            path.push_str(format!("&{key}={value}").as_str());
        }

        path
    }

    /// Returns JSON data struct
    ///
    /// # Errors
    /// Raise error if data obtained cannot be properly converted to struct or
    /// API returns any 4 possible known errors
    pub async fn json<T>(&self) -> Result<T>
    where
        T: DeserializeOwned,
    {
        let url = self.create_url();
        self.api_client.get_json(&url).await
    }
}