ipdata 0.1.1

Official Rust client for the ipdata.co IP geolocation and threat intelligence 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

/// Error type for the ipdata client.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// HTTP transport error from reqwest.
    #[error("{0}")]
    Http(#[from] reqwest::Error),

    /// API returned a non-success status code.
    #[error("API error (HTTP {status}): {message}")]
    Api {
        /// HTTP status code.
        status: u16,
        /// Error message from the API response.
        message: String,
    },

    /// The provided string is not a valid IP address.
    #[error("invalid IP address: {0}")]
    InvalidIp(String),

    /// Bulk lookup exceeds the maximum of 100 IPs.
    #[error("bulk lookup exceeds maximum of 100 IPs")]
    BulkLimitExceeded,

    /// Bulk lookup requires at least one IP address.
    #[error("bulk lookup requires at least one IP address")]
    BulkEmpty,
}

/// Convenience type alias.
pub type Result<T> = std::result::Result<T, Error>;

/// API error response body.
#[derive(Debug, serde::Deserialize)]
pub(crate) struct ApiErrorResponse {
    pub message: String,
}

impl Error {
    /// Returns the HTTP status code if this is an API error.
    pub fn status(&self) -> Option<u16> {
        match self {
            Error::Api { status, .. } => Some(*status),
            _ => None,
        }
    }
}