gw2api 0.2.0

A sort-of well-documented and WIP wrapper over the Guild Wars 2 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

use serde::de;
use std::fmt::{self, Display};

/// This error is raised whenever an error occurs when calling the Guild Wars 2 API, for example by
/// trying to access a resource that requires authentication without a valid API key, or trying to
/// access a non-existent item id.
///
/// The most relevant field is the text field describing the error, rest are probably for internal
/// use by ArenaNet.
#[derive(Debug, Clone, Deserialize, PartialEq)]
pub struct ApiError {
    ///// Error code.
    //code: Option<u32>,
    ///// Product where the error concerns.
    //product: Option<u32>,
    ///// Which module the error occurred in.
    //module: Option<u32>,
    ///// At what line the error occurred.
    //line: Option<u32>,
    /// Text describing the error retrieved from the API.
    text: String,
}

impl de::Error for ApiError {
    fn custom<T: std::string::ToString>(msg: T) -> Self {
        ApiError {
            text: msg.to_string(),
        }
    }
}

impl Display for ApiError {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        formatter.write_str(&self.to_string())
    }
}

impl std::error::Error for ApiError {
    fn description(&self) -> &str {
        &self.text
    }
}

impl ApiError {
    /// Create a new ApiError from any type T that implements the Display trait.
    pub fn new(text: impl Display) -> ApiError {
        ApiError {
            text: text.to_string(),
        }
    }

    /// Returns the description of the error.
    pub fn description(&self) -> &str {
        &self.text
    }
}