rspark 0.2.0

Sparklines 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

#![crate_name = "rspark"]

pub mod rspark {

    use std::error::Error;
    use std::fmt;

    /// Unicode graph ticks representation
    const TICKS: [char; 8] = [
        '\u{2581}', '\u{2582}', '\u{2583}', '\u{2584}', '\u{2585}', '\u{2586}', '\u{2587}',
        '\u{2588}',
    ];

    /// Renders graph for input vector
    ///
    /// # Arguments
    ///
    /// * `v` - Input numeric vector
    ///
    /// # Examples
    ///
    /// ```
    /// let v = vec![2, 250, 670, 890, 2, 430, 11, 908, 123, 57];
    /// let res = rspark::rspark::render(&v).unwrap();
    /// assert_eq!("▁▂▆▇▁▄▁█▁▁", res);
    /// ```
    pub fn render(v: &Vec<i32>) -> Result<String, RenderError> {
        let mut s = String::new();
        render_to(v, &mut s)
            .map(|ok_val| ok_val.to_string())
            .map_err(|err_val| err_val)
    }

    /// Appends rendered graph for input vector to given string
    ///
    /// # Arguments
    ///
    /// * `v` - Input numeric vector
    /// * `s` - Mutable String pointer for rendered graph
    ///
    /// # Examples
    ///
    /// ```
    /// let v = vec![2, 250, 670, 890, 2, 430, 11, 908, 123, 57];
    /// let mut s = String::new();
    /// let res = rspark::rspark::render_to(&v, &mut s).unwrap();
    /// assert_eq!("▁▂▆▇▁▄▁█▁▁", res);
    /// ```
    pub fn render_to<'a>(v: &Vec<i32>, s: &'a mut String) -> Result<&'a str, RenderError> {
        if v.len() < 2 {
            return Err(RenderError::InvalidVectorParameter);
        }
        let max = v.iter().max().unwrap();
        let min = v.iter().min().unwrap();
        let scale = (max - min) as f32 / 7.;
        for e in v.iter() {
            let i = (e - min) / scale as i32;
            (*s).push_str(&TICKS[i as usize].to_string());
        }
        Ok(&s[..])
    }

    #[derive(Debug)]
    pub enum RenderError {
        /// Invalid vector parameter error
        InvalidVectorParameter,
    }

    impl fmt::Display for RenderError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match *self {
                RenderError::InvalidVectorParameter => f.write_str("InvalidVectorParameter"),
            }
        }
    }

    impl Error for RenderError {
        fn description(&self) -> &str {
            match *self {
                RenderError::InvalidVectorParameter => "Invalid vector parameter",
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_render() {
        let v = vec![2, 250, 670, 890, 2, 430, 11, 908, 123, 57];
        let res = rspark::render(&v).unwrap();
        println!("{}", res);
        assert_eq!("▁▂▆▇▁▄▁█▁▁", res);
    }

    #[test]
    fn test_render_to() {
        let v = vec![2, 250, 670, 890, 2, 430, 11, 908, 123, 57];
        let mut s = String::new();
        let res = rspark::render_to(&v, &mut s).unwrap();
        println!("{}", res);
        assert_eq!("▁▂▆▇▁▄▁█▁▁", res);
    }

    #[test]
    fn test_render_err() {
        let v = vec![2];
        let res = rspark::render(&v);
        match res {
            Ok(_) => panic!("Error expected."),
            _ => (),
        }
    }
}