api_bindium 0.4.0

Framework for api binding crates
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

use core::error::Error as _;

use snafu::Snafu;
use ureq::http::Uri;

#[derive(Debug, Snafu)]
#[snafu(visibility(pub(crate)))]
pub enum ApiRequestError {
    #[snafu(display("Couldn't successfully send the http request to {uri}"))]
    UreqError {
        source: ureq::Error,

        #[snafu(implicit)]
        location: snafu::Location,

        uri: Uri,

        #[cfg(feature = "backtrace")]
        backtrace: snafu::Backtrace,
    },

    #[snafu(display("Couldn't parse the response of {uri}"))]
    ParsingError {
        source: ureq::Error,

        #[snafu(implicit)]
        location: snafu::Location,

        uri: Uri,

        #[cfg(feature = "backtrace")]
        backtrace: snafu::Backtrace,
    },

    #[snafu(display(
        "The max retry count for the request as been exeeded. You may want to check if the correct url is set, the server is online, or you aren't hitting the ratelimit."
    ))]
    MaxRetriesExceeded {
        #[snafu(implicit)]
        location: snafu::Location,

        #[cfg(feature = "backtrace")]
        backtrace: snafu::Backtrace,
    },

    #[snafu(display("The api's response couldn't be deserialized:\n{data}"))]
    JsonParsingError {
        source: serde_json::Error,
        data: String,

        #[snafu(implicit)]
        location: snafu::Location,

        #[cfg(feature = "backtrace")]
        backtrace: snafu::Backtrace,
    },

    #[cfg(feature = "image")]
    #[snafu(display("Couldn't parse the image"))]
    ImageParsingError {
        source: image::ImageError,
        data: Vec<u8>,

        #[snafu(implicit)]
        location: snafu::Location,

        #[cfg(feature = "backtrace")]
        backtrace: snafu::Backtrace,
    },
}

impl ApiRequestError {
    /// Return true if the error is temporary and should be retried
    pub fn is_retryable(&self) -> bool {
        self.is_timeout() || self.is_connection_reset() || self.is_peer_disconnected()
    }

    /// Return true if the error is a timeout
    pub fn is_timeout(&self) -> bool {
        // Reqwest error
        let Some(source) = self.source() else {
            return false;
        };

        let Some(ureq_error) = source.downcast_ref::<ureq::Error>() else {
            return false;
        };

        matches!(ureq_error, ureq::Error::Timeout(_))
    }

    /// Return true if the error is a connection reset
    pub fn is_connection_reset(&self) -> bool {
        let Some(source) = self.source() else {
            return false;
        };

        let Some(ureq_error) = source.downcast_ref::<ureq::Error>() else {
            return false;
        };

        let ureq::Error::Io(std_error) = ureq_error else {
            return false;
        };

        std_error.kind() == std::io::ErrorKind::ConnectionReset
    }

    pub fn is_peer_disconnected(&self) -> bool {
        let Some(source) = self.source() else {
            return false;
        };

        let Some(ureq_error) = source.downcast_ref::<ureq::Error>() else {
            return false;
        };

        let ureq::Error::Io(std_error) = ureq_error else {
            return false;
        };

        std_error.kind() == std::io::ErrorKind::UnexpectedEof
    }
}