xposedornot 1.0.1

Rust client library for the XposedOrNot data breach 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

//! Error types for the XposedOrNot client.

/// Errors that can occur when interacting with the XposedOrNot API.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Rate limit exceeded (HTTP 429). Contains the retry-after duration if available.
    #[error("rate limit exceeded: {message}")]
    RateLimit {
        /// Human-readable description of the rate limit error.
        message: String,
    },

    /// Resource not found (HTTP 404). The requested email or breach was not found.
    #[error("not found: {message}")]
    NotFound {
        /// Human-readable description of what was not found.
        message: String,
    },

    /// Authentication failure (HTTP 401/403). The API key is missing or invalid.
    #[error("authentication failed: {message}")]
    Authentication {
        /// Human-readable description of the authentication error.
        message: String,
    },

    /// Validation error. Input parameters failed client-side validation.
    #[error("validation error: {message}")]
    Validation {
        /// Human-readable description of the validation error.
        message: String,
    },

    /// Network or connection error from the underlying HTTP client.
    #[error("network error: {source}")]
    Network {
        /// The underlying reqwest error.
        #[from]
        source: reqwest::Error,
    },

    /// API returned an unexpected response or server error.
    #[error("API error (status {status_code}): {message}")]
    Api {
        /// The HTTP status code returned by the API.
        status_code: u16,
        /// Human-readable error message.
        message: String,
    },
}

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