xplane-web-api 0.1.0

Bindings to the X-Plane Web APIs (REST and websocket)
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! REST client error classification helpers.

use thiserror::Error;

use crate::rest;

/// Unified error type for generated REST client calls.
#[allow(missing_docs)]
#[derive(Debug, Error)]
pub enum RestClientError {
    #[error("invalid request: {message}")]
    InvalidRequest { message: String },

    #[error("reqwest timeout: {source}")]
    ReqwestTimeout {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest connect error: {source}")]
    ReqwestConnect {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest request construction error: {source}")]
    ReqwestRequest {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest redirect error: {source}")]
    ReqwestRedirect {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest HTTP status error: {source}")]
    ReqwestStatus {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest response body error: {source}")]
    ReqwestBody {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest decode error: {source}")]
    ReqwestDecode {
        #[source]
        source: reqwest::Error,
    },

    #[error("reqwest error: {source}")]
    ReqwestOther {
        #[source]
        source: reqwest::Error,
    },

    #[error("documented API error response: HTTP {status} {error_code}: {error_message}")]
    ApiErrorResponse {
        status: reqwest::StatusCode,
        error_code: String,
        error_message: String,
    },

    #[error("undocumented error response: HTTP {status}")]
    UndocumentedErrorResponse { status: reqwest::StatusCode },

    #[error("invalid response payload: {source}")]
    InvalidResponsePayload {
        #[source]
        source: serde_json::Error,
    },

    #[error("unexpected response: HTTP {status}")]
    UnexpectedResponse { status: reqwest::StatusCode },

    #[error("{message}")]
    Custom { message: String },
}

fn reqwest_error(source: reqwest::Error) -> RestClientError {
    if source.is_timeout() {
        RestClientError::ReqwestTimeout { source }
    } else if source.is_connect() {
        RestClientError::ReqwestConnect { source }
    } else if source.is_request() {
        RestClientError::ReqwestRequest { source }
    } else if source.is_redirect() {
        RestClientError::ReqwestRedirect { source }
    } else if source.is_status() {
        RestClientError::ReqwestStatus { source }
    } else if source.is_body() {
        RestClientError::ReqwestBody { source }
    } else if source.is_decode() {
        RestClientError::ReqwestDecode { source }
    } else {
        RestClientError::ReqwestOther { source }
    }
}

fn map_rest_error<T>(
    source: rest::Error<T>,
    to_api_fields: impl FnOnce(T) -> Option<(String, String)>,
) -> RestClientError {
    match source {
        rest::Error::InvalidRequest(message) => RestClientError::InvalidRequest { message },
        rest::Error::CommunicationError(source)
        | rest::Error::InvalidUpgrade(source)
        | rest::Error::ResponseBodyError(source) => reqwest_error(source),
        rest::Error::ErrorResponse(response) => {
            let status = response.status();
            let response_body = response.into_inner();
            if let Some((error_code, error_message)) = to_api_fields(response_body) {
                RestClientError::ApiErrorResponse {
                    status,
                    error_code,
                    error_message,
                }
            } else {
                RestClientError::UndocumentedErrorResponse { status }
            }
        }
        rest::Error::InvalidResponsePayload(_, source) => {
            RestClientError::InvalidResponsePayload { source }
        }
        rest::Error::UnexpectedResponse(response) => RestClientError::UnexpectedResponse {
            status: response.status(),
        },
        rest::Error::Custom(message) => RestClientError::Custom { message },
    }
}

impl From<rest::Error<()>> for RestClientError {
    fn from(source: rest::Error<()>) -> Self {
        map_rest_error(source, |_| None)
    }
}

impl From<rest::Error<rest::types::ApiError>> for RestClientError {
    fn from(source: rest::Error<rest::types::ApiError>) -> Self {
        map_rest_error(source, |api_error| {
            Some((api_error.error_code, api_error.error_message))
        })
    }
}