rocksky 0.3.0

Async Rust SDK for the Rocksky XRPC 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
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

//! SDK error types.
//!
//! All fallible methods return [`Result<T>`]. `Error::Api` carries the full
//! server response (status, XRPC method id, error code, message, body).

use serde_json::Value;
use thiserror::Error;

pub type Result<T, E = Error> = std::result::Result<T, E>;

/// Top-level error returned by every SDK call.
#[derive(Debug, Error)]
pub enum Error {
    /// The server returned a non-2xx response.
    #[error("[{status}] {method}: {summary}", summary = .message.as_deref().or(.error.as_deref()).unwrap_or("no message"))]
    Api {
        status: u16,
        method: String,
        error: Option<String>,
        message: Option<String>,
        body: Option<Value>,
    },

    /// Request didn't reach the server (network / timeout / TLS).
    #[error("transport error calling {method}: {source}")]
    Transport {
        method: String,
        #[source]
        source: reqwest::Error,
    },

    /// Failed to parse / serialize JSON.
    #[error("json error in {method}: {source}")]
    Json {
        method: String,
        #[source]
        source: serde_json::Error,
    },

    /// Caller supplied an invalid configuration (bad URL, missing token, …).
    #[error("invalid configuration: {0}")]
    InvalidConfig(String),

    /// Method requires authentication and no token is set on the client.
    #[error("[401] {method}: missing token — call ClientBuilder::token(...) or Client::set_token(...)")]
    MissingToken { method: String },
}

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

    /// True for 4xx responses (client errors).
    pub fn is_client_error(&self) -> bool {
        matches!(self.status(), Some(s) if (400..500).contains(&s))
    }

    /// True for 5xx responses (server errors).
    pub fn is_server_error(&self) -> bool {
        matches!(self.status(), Some(s) if (500..600).contains(&s))
    }

    /// True for 401 Unauthorized.
    pub fn is_unauthorized(&self) -> bool {
        matches!(self.status(), Some(401))
    }

    /// True for 403 Forbidden.
    pub fn is_forbidden(&self) -> bool {
        matches!(self.status(), Some(403))
    }

    /// True for 404 Not Found.
    pub fn is_not_found(&self) -> bool {
        matches!(self.status(), Some(404))
    }

    /// True for 429 Too Many Requests.
    pub fn is_rate_limited(&self) -> bool {
        matches!(self.status(), Some(429))
    }
}