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
150
151
152
153
154
155
156
157
158
159
160

//! Errors that can be sent from the homeserver.

use ruma_api::{error::ResponseDeserializationError, EndpointError};
use serde::{Deserialize, Serialize};

/// An enum for the error kind. Items may contain additional information.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[serde(tag = "errcode")]
pub enum ErrorKind {
    /// M_FORBIDDEN
    #[serde(rename = "M_FORBIDDEN")]
    Forbidden,
    /// M_UNKNOWN_TOKEN
    #[serde(rename = "M_UNKNOWN_TOKEN")]
    UnknownToken,
    /// M_MISSING_TOKEN
    #[serde(rename = "M_MISSING_TOKEN")]
    MissingToken,
    /// M_BAD_JSON
    #[serde(rename = "M_BAD_JSON")]
    BadJson,
    /// M_NOT_JSON
    #[serde(rename = "M_NOT_JSON")]
    NotJson,
    /// M_NOT_FOUND
    #[serde(rename = "M_NOT_FOUND")]
    NotFound,
    /// M_LIMIT_EXCEEDED
    #[serde(rename = "M_LIMIT_EXCEEDED")]
    LimitExceeded,
    /// M_UNKNOWN
    #[serde(rename = "M_UNKNOWN")]
    Unknown,
    /// M_UNRECOGNIZED
    #[serde(rename = "M_UNRECOGNIZED")]
    Unrecognized,
    /// M_UNAUTHORIZED
    #[serde(rename = "M_UNAUTHORIZED")]
    Unauthorized,
    /// M_USER_IN_USE
    #[serde(rename = "M_USER_IN_USE")]
    UserInUse,
    /// M_INVALID_USERNAME
    #[serde(rename = "M_INVALID_USERNAME")]
    InvalidUsername,
    /// M_ROOM_IN_USE
    #[serde(rename = "M_ROOM_IN_USE")]
    RoomInUse,
    /// M_INVALID_ROOM_STATE
    #[serde(rename = "M_INVALID_ROOM_STATE")]
    InvalidRoomState,
    /// M_THREEPID_IN_USE
    #[serde(rename = "M_THREEPID_IN_USE")]
    ThreepidInUse,
    /// M_THREEPID_NOT_FOUND
    #[serde(rename = "M_THREEPID_NOT_FOUND")]
    ThreepidNotFound,
    /// M_THREEPID_AUTH_FAILED
    #[serde(rename = "M_THREEPID_AUTH_FAILED")]
    ThreepidAuthFailed,
    /// M_THREEPID_DENIED
    #[serde(rename = "M_THREEPID_DENIED")]
    ThreepidDenied,
    /// M_SERVER_NOT_TRUSTED
    #[serde(rename = "M_SERVER_NOT_TRUSTED")]
    ServerNotTrusted,
    /// M_UNSUPPORTED_ROOM_VERSION
    #[serde(rename = "M_UNSUPPORTED_ROOM_VERSION")]
    UnsupportedRoomVersion,
    /// M_INCOMPATIBLE_ROOM_VERSION
    #[serde(rename = "M_INCOMPATIBLE_ROOM_VERSION")]
    IncompatibleRoomVersion,
    /// M_BAD_STATE
    #[serde(rename = "M_BAD_STATE")]
    BadState,
    /// M_GUEST_ACCESS_FORBIDDEN
    #[serde(rename = "M_GUEST_ACCESS_FORBIDDEN")]
    GuestAccessForbidden,
    /// M_CAPTCHA_NEEDED
    #[serde(rename = "M_CAPTCHA_NEEDED")]
    CaptchaNeeded,
    /// M_CAPTCHA_INVALID
    #[serde(rename = "M_CAPTCHA_INVALID")]
    CaptchaInvalid,
    /// M_MISSING_PARAM
    #[serde(rename = "M_MISSING_PARAM")]
    MissingParam,
    /// M_INVALID_PARAM
    #[serde(rename = "M_INVALID_PARAM")]
    InvalidParam,
    /// M_TOO_LARGE
    #[serde(rename = "M_TOO_LARGE")]
    TooLarge,
    /// M_EXCLUSIVE
    #[serde(rename = "M_EXCLUSIVE")]
    Exclusive,
}

/// A Matrix Error without a status code
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ErrorBody {
    /// A value which can be used to handle an error message
    #[serde(flatten)]
    pub kind: ErrorKind,
    /// A human-readable error message, usually a sentence explaining what went wrong.
    #[serde(rename = "error")]
    pub message: String,
}

/// A Matrix Error
#[derive(Debug, Clone)]
pub struct Error {
    /// A value which can be used to handle an error message
    pub kind: ErrorKind,
    /// A human-readable error message, usually a sentence explaining what went wrong.
    pub message: String,
    /// The http status code
    pub status_code: http::StatusCode,
}

impl EndpointError for Error {
    fn try_from_response(
        response: http::Response<Vec<u8>>,
    ) -> Result<Self, ResponseDeserializationError> {
        match serde_json::from_slice::<ErrorBody>(response.body()) {
            Ok(error_body) => Ok(error_body.into_error(response.status())),
            Err(de_error) => Err(ResponseDeserializationError::new(de_error, response)),
        }
    }
}

impl From<Error> for ErrorBody {
    fn from(error: Error) -> Self {
        Self {
            kind: error.kind,
            message: error.message,
        }
    }
}

impl ErrorBody {
    /// Convert the ErrorBody into an Error by adding the http status code.
    pub fn into_error(self, status_code: http::StatusCode) -> Error {
        Error {
            kind: self.kind,
            message: self.message,
            status_code,
        }
    }
}

impl From<Error> for http::Response<Vec<u8>> {
    fn from(error: Error) -> http::Response<Vec<u8>> {
        http::Response::builder()
            .header(http::header::CONTENT_TYPE, "application/json")
            .status(error.status_code)
            .body(serde_json::to_vec(&ErrorBody::from(error)).unwrap())
            .unwrap()
    }
}