pincho 1.0.0-alpha.1

Official Rust Client Library for Pincho - Send push notifications with async/await support
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

use thiserror::Error;

/// Result type for Pincho operations
pub type Result<T> = std::result::Result<T, Error>;

/// Main error type for the Pincho Client Library
#[derive(Error, Debug)]
pub enum Error {
    /// Authentication failed (401, 403)
    #[error("Authentication failed: {message} (HTTP {status_code})")]
    Authentication {
        /// Error message from the API
        message: String,
        /// HTTP status code
        status_code: u16,
    },

    /// Validation error (400, 404)
    #[error("Validation error: {message} (HTTP {status_code})")]
    Validation {
        /// Error message from the API
        message: String,
        /// HTTP status code
        status_code: u16,
    },

    /// Rate limit exceeded (429)
    #[error("Rate limit exceeded: {message} (HTTP {status_code})")]
    RateLimit {
        /// Error message from the API
        message: String,
        /// HTTP status code
        status_code: u16,
    },

    /// HTTP request error
    #[error("HTTP request failed: {0}")]
    Request(#[from] reqwest::Error),

    /// JSON serialization/deserialization error
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    /// API returned an error
    #[error("API error: {message} (HTTP {status_code})")]
    Api {
        /// Error message from the API
        message: String,
        /// HTTP status code
        status_code: u16,
    },

    /// Invalid configuration
    #[error("Invalid configuration: {0}")]
    InvalidConfig(String),

    /// Builder validation error
    #[error("Builder validation error: {0}")]
    BuilderValidation(String),
}

impl Error {
    /// Returns the HTTP status code if available
    pub fn status_code(&self) -> Option<u16> {
        match self {
            Error::Authentication { status_code, .. }
            | Error::Validation { status_code, .. }
            | Error::RateLimit { status_code, .. }
            | Error::Api { status_code, .. } => Some(*status_code),
            _ => None,
        }
    }

    /// Returns true if this is an authentication error
    pub fn is_authentication_error(&self) -> bool {
        matches!(self, Error::Authentication { .. })
    }

    /// Returns true if this is a validation error
    pub fn is_validation_error(&self) -> bool {
        matches!(self, Error::Validation { .. })
    }

    /// Returns true if this is a rate limit error
    pub fn is_rate_limit_error(&self) -> bool {
        matches!(self, Error::RateLimit { .. })
    }

    /// Returns true if this error is retryable
    ///
    /// Retryable errors include:
    /// - Rate limit errors (429)
    /// - Server errors (5xx)
    /// - Network/connection errors
    pub fn is_retryable(&self) -> bool {
        match self {
            Error::RateLimit { .. } => true,
            Error::Api { status_code, .. } => *status_code >= 500,
            Error::Request(e) => {
                // Network errors are retryable
                e.is_connect() || e.is_timeout()
            }
            _ => false,
        }
    }
}