rvk 0.13.0

Crate for accessing VK (VKontakte) 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
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! Represents errors that can happen during a method call.

use failure_derive::Fail;
use serde_derive::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;

/// Convenience type for defining `Result`s.
pub type Result<T> = std::result::Result<T, Error>;

/// An error returned by the API.
#[derive(Fail, Deserialize, Serialize, Debug, PartialEq, Clone)]
#[fail(display = "API Error #{}: {}", error_code, error_msg)]
pub struct APIError {
    error_code: u64,
    error_msg: String,

    #[serde(flatten)]
    extra: HashMap<String, Value>,
}

impl APIError {
    /// Creates a new `APIError`.
    pub fn new(code: u64, msg: String, extra: HashMap<String, Value>) -> Self {
        Self {
            error_code: code,
            error_msg: msg,
            extra,
        }
    }

    /// Returns the code of this `APIError`.
    ///
    /// ```
    /// # use rvk::error::APIError;
    /// # use std::collections::HashMap;
    ///
    /// let err = APIError::new(0, "test".into(), HashMap::new());
    /// assert_eq!(err.code(), 0);
    /// ```
    pub fn code(&self) -> u64 {
        self.error_code
    }

    /// Returns the message of this `APIError`.
    ///
    /// ```
    /// # use rvk::error::APIError;
    /// # use std::collections::HashMap;
    ///
    /// let err = APIError::new(0, "test".into(), HashMap::new());
    /// assert_eq!(err.msg(), "test");
    /// ```
    pub fn msg(&self) -> &String {
        &self.error_msg
    }

    /// Returns the extra fields of this `APIError`.
    ///
    /// ```
    /// # use rvk::error::APIError;
    /// # use std::collections::HashMap;
    /// # use serde_json::Value;
    ///
    /// let err = APIError::new(0, "test".into(), HashMap::new());
    /// assert_eq!(err.extra().clone(), HashMap::<String, Value>::new());
    /// ```
    pub fn extra(&self) -> &HashMap<String, Value> {
        &self.extra
    }
}

/// A generic error.
#[derive(Fail, Debug)]
pub enum Error {
    /// Errors from the API.
    #[fail(display = "{}", _0)]
    API(#[cause] APIError),

    /// Errors with making a request.
    #[fail(display = "Request error: {}", _0)]
    Request(#[cause] reqwest::Error),

    /// Serialization/Deserialization errors.
    #[fail(display = "Serialization/Deserialization error: {}", _0)]
    Serde(#[cause] serde_json::error::Error),

    /// Other errors.
    #[fail(display = "Other error: {}", _0)]
    Other(String),
}

impl From<APIError> for Error {
    fn from(e: APIError) -> Error {
        Error::API(e)
    }
}

impl From<reqwest::Error> for Error {
    fn from(e: reqwest::Error) -> Error {
        Error::Request(e)
    }
}

impl From<serde_json::error::Error> for Error {
    fn from(e: serde_json::error::Error) -> Error {
        Error::Serde(e)
    }
}

impl From<String> for Error {
    fn from(s: String) -> Error {
        Error::Other(s)
    }
}

impl From<&str> for Error {
    fn from(s: &str) -> Error {
        s.to_string().into()
    }
}

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

    #[test]
    fn api_error() {
        let api_err = APIError::new(0, "test".to_string(), HashMap::new());
        let err: Error = api_err.clone().into();

        match err {
            Error::API(e) => assert_eq!(e, api_err),
            _ => unreachable!(),
        }
    }

    #[test]
    fn other_error_from_str() {
        let other_err = "error";
        let err: Error = other_err.clone().into();

        match err {
            Error::Other(s) => assert_eq!(s, other_err),
            _ => unreachable!(),
        }
    }

    #[test]
    fn other_error_from_string() {
        let other_err = "error".to_string();
        let err: Error = other_err.clone().into();

        match err {
            Error::Other(s) => assert_eq!(s, other_err),
            _ => unreachable!(),
        }
    }
}