avassa-client 0.14.0

Library for integrating with the Avassa APIs
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
107
108
109
110
111
112
113

//! Library errors.

/// Description of an error from the REST APIs.
#[derive(Debug,serde::Deserialize)]
#[non_exhaustive]
pub struct RESTError {
    /// Error message.
    #[serde(rename = "error-message")]
    pub error_message: String,
    /// Additonal error information.
    #[serde(rename = "error-info")]
    pub error_info: serde_json::Value,
}

/// List of REST API error messages.
#[derive(Debug,serde::Deserialize)]
#[non_exhaustive]
pub struct RESTErrorList {
    /// Error messages.
    pub errors: Vec<RESTError>,
}

/// Error returned by client functions.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
#[expect(clippy::error_impl_error, reason="Backwards compat")]
pub enum Error {
    /// Login failed.
    #[error("Login failed: {0}")]
    LoginFailure(String),

    /// Application login failed because an environment variable is missing.
    #[error("Login failure, missing environment variable '{0}'")]
    LoginFailureMissingEnv(String),

    /// Failed returned by the HTTP server.
    #[error("HTTP failed {0}, {1} - {2}")]
    WebServer(u16, String, String),

    /// Websocket error.
    #[cfg(feature = "client")]
    #[error("Websocket error: {0}")]
    WebSocket(Box<tokio_tungstenite::tungstenite::Error>),

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

    /// URL parsing error.
    #[cfg(feature = "client")]
    #[error("URL: {0}")]
    URL(#[from] url::ParseError),

    /// HTTP client error.
    #[cfg(feature = "client")]
    #[error("Reqwest: {0}")]
    HTTPClient(#[from] reqwest::Error),

    /// Volga error.
    #[error("Error from Volga {0:?}")]
    Volga(Option<String>),

    /// This error is returned if we get data from the API we can't parse/understand.
    #[error("API Error {0:?}")]
    API(String),

    /// This error is returned from the REST API, this typically means the client did something.
    /// wrong.
    #[error("REST error {0:?}")]
    REST(RESTErrorList),

    /// TLS Errors.
    #[cfg(feature = "client")]
    #[error("TLS error {0}")]
    TLS(#[from] tokio_rustls::rustls::Error),

    /// DNS Error.
    #[cfg(feature = "client")]
    #[error("DNSName error {0}")]
    DNSName(#[from] tokio_rustls::rustls::pki_types::InvalidDnsNameError),

    /// IO Errors.
    #[error("IO error {0}")]
    IO(#[from] std::io::Error),

    /// General Error.
    #[error("Error {0}")]
    General(String),

    /// Convert web socket URL to URI.
    #[error("Conversion error {0}")]
    InvalidURI(#[from] http::uri::InvalidUri),
}

impl Error {
    /// Create a general error.
    #[must_use]
    #[inline]
    pub fn general(err: &str) -> Self {
        Self::General(err.to_owned())
    }
}

impl From<tokio_tungstenite::tungstenite::Error> for Error {
    #[inline]
    fn from(err: tokio_tungstenite::tungstenite::Error) -> Self {
        Self::WebSocket(Box::new(err))
    }
}

/// Result type.
pub type Result<T> = core::result::Result<T, Error>;