bitbucket-server-rs 0.5.0

An API client library for Bitbucket Data Center
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

use thiserror::Error;

/// Error types that can occur when making API requests.
///
/// This enum represents the different types of errors that can occur when making
/// API requests to the Bitbucket Server API.
#[derive(Debug, Error)]
pub enum Error {
    /// Error building the request.
    #[error("Error building the request: {0}")]
    RequestError(String),

    /// Error getting the response.
    #[error("Error getting the response: {0}")]
    ResponseError(String),

    /// Authentication error (HTTP 401 or 403).
    #[error("Authentication error")]
    Unauthorized,

    /// Unexpected error with a custom message.
    #[error("Unexpected error: {0}" )]
    Unexpected(String),
}

impl Error {
    /// Check if the error is an authentication error (HTTP 401 or 403).
    ///
    /// # Returns
    ///
    /// `true` if the error is an authentication error, `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use bitbucket_server_rs::Error;
    ///
    /// let error = Error::Unauthorized;
    /// assert!(error.is_unauthorized());
    /// ```
    pub fn is_unauthorized(&self) -> bool {
        matches!(self, Error::Unauthorized)
    }

    /// Check if the error is a request error.
    ///
    /// # Returns
    ///
    /// `true` if the error is a request error, `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use bitbucket_server_rs::Error;
    ///
    /// let error = Error::RequestError("Failed to build request".to_string());
    /// assert!(error.is_request_error());
    /// ```
    pub fn is_request_error(&self) -> bool {
        matches!(self, Error::RequestError(_))
    }

    /// Check if the error is a response error.
    ///
    /// # Returns
    ///
    /// `true` if the error is a response error, `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use bitbucket_server_rs::Error;
    ///
    /// let error = Error::ResponseError("Failed to parse response".to_string());
    /// assert!(error.is_response_error());
    /// ```
    pub fn is_response_error(&self) -> bool {
        matches!(self, Error::ResponseError(_))
    }

    /// Check if the error is an unexpected error.
    ///
    /// # Returns
    ///
    /// `true` if the error is an unexpected error, `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use bitbucket_server_rs::Error;
    ///
    /// let error = Error::Unexpected("Something went wrong".to_string());
    /// assert!(error.is_unexpected());
    /// ```
    pub fn is_unexpected(&self) -> bool {
        matches!(self, Error::Unexpected(_))
    }
}