ruma_identifiers_validation/
error.rs

Help
1//! Error conditions.
2
3use std::str::Utf8Error;
4
5/// An error encountered when trying to parse an invalid ID string.
6#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
7#[non_exhaustive]
8pub enum Error {
9    /// The identifier or a required part of it is empty.
10    #[error("identifier or required part of it is empty")]
11    Empty,
12
13    /// The identifier contains invalid characters.
14    #[error("identifier contains invalid characters")]
15    InvalidCharacters,
16
17    /// The string isn't a valid Matrix ID.
18    #[error("invalid matrix ID: {0}")]
19    InvalidMatrixId(#[from] MatrixIdError),
20
21    /// The string isn't a valid Matrix.to URI.
22    #[error("invalid matrix.to URI: {0}")]
23    InvalidMatrixToUri(#[from] MatrixToError),
24
25    /// The string isn't a valid Matrix URI.
26    #[error("invalid matrix URI: {0}")]
27    InvalidMatrixUri(#[from] MatrixUriError),
28
29    /// The mxc:// isn't a valid Matrix Content URI.
30    #[error("invalid Matrix Content URI: {0}")]
31    InvalidMxcUri(#[from] MxcUriError),
32
33    /// The value isn't a valid VoIP version Id.
34    #[error("invalid VoIP version ID: {0}")]
35    InvalidVoipVersionId(#[from] VoipVersionIdError),
36
37    /// The server name part of the the ID string is not a valid server name.
38    #[error("server name is not a valid IP address or domain name")]
39    InvalidServerName,
40
41    /// The string isn't valid UTF-8.
42    #[error("invalid UTF-8")]
43    InvalidUtf8,
44
45    /// The ID exceeds 255 bytes (or 32 codepoints for a room version ID).
46    #[error("ID exceeds 255 bytes")]
47    MaximumLengthExceeded,
48
49    /// The ID is missing the colon delimiter between localpart and server name, or between key
50    /// algorithm and key name / version.
51    #[error("required colon is missing")]
52    MissingColon,
53
54    /// The ID is missing the correct leading sigil.
55    #[error("leading sigil is incorrect or missing")]
56    MissingLeadingSigil,
57}
58
59impl From<Utf8Error> for Error {
60    fn from(_: Utf8Error) -> Self {
61        Self::InvalidUtf8
62    }
63}
64
65/// An error occurred while validating an MXC URI.
66#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
67#[non_exhaustive]
68pub enum MxcUriError {
69    /// MXC URI did not start with `mxc://`.
70    #[error("MXC URI schema was not mxc://")]
71    WrongSchema,
72
73    /// MXC URI did not have first slash, required for `server.name/media_id`.
74    #[error("MXC URI does not have first slash")]
75    MissingSlash,
76
77    /// Media identifier malformed due to invalid characters detected.
78    ///
79    /// Valid characters are (in regex notation) `[A-Za-z0-9_-]+`.
80    /// See [here](https://spec.matrix.org/v1.14/client-server-api/#security-considerations-5) for more details.
81    #[error("Media Identifier malformed, invalid characters")]
82    MediaIdMalformed,
83
84    /// Server identifier malformed: invalid IP or domain name.
85    #[error("invalid Server Name")]
86    ServerNameMalformed,
87}
88
89/// An error occurred while validating a `MatrixId`.
90#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
91#[non_exhaustive]
92pub enum MatrixIdError {
93    /// The string contains an invalid number of parts.
94    #[error("invalid number of parts")]
95    InvalidPartsNumber,
96
97    /// The string is missing a room ID or alias.
98    #[error("missing room ID or alias")]
99    MissingRoom,
100
101    /// The string contains no identifier.
102    #[error("no identifier")]
103    NoIdentifier,
104
105    /// The string contains too many identifiers.
106    #[error("too many identifiers")]
107    TooManyIdentifiers,
108
109    /// The string contains an unknown identifier.
110    #[error("unknown identifier")]
111    UnknownIdentifier,
112
113    /// The string contains two identifiers that cannot be paired.
114    #[error("unknown identifier pair")]
115    UnknownIdentifierPair,
116
117    /// The string contains an unknown identifier type.
118    #[error("unknown identifier type")]
119    UnknownType,
120}
121
122/// An error occurred while validating a `matrix.to` URI.
123#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
124#[non_exhaustive]
125pub enum MatrixToError {
126    /// String is not a valid URI.
127    #[error("given string is not a valid URL")]
128    InvalidUrl,
129
130    /// String did not start with `https://matrix.to/#/`.
131    #[error("base URL is not https://matrix.to/#/")]
132    WrongBaseUrl,
133
134    /// String has an unknown additional argument.
135    #[error("unknown additional argument")]
136    UnknownArgument,
137}
138
139/// An error occurred while validating a `MatrixURI`.
140#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
141#[non_exhaustive]
142pub enum MatrixUriError {
143    /// The string does not start with `matrix:`.
144    #[error("scheme is not 'matrix:'")]
145    WrongScheme,
146
147    /// The string contains too many actions.
148    #[error("too many actions")]
149    TooManyActions,
150
151    /// The string contains an unknown query item.
152    #[error("unknown query item")]
153    UnknownQueryItem,
154}
155
156/// An error occurred while validating a `VoipVersionId`.
157#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq, thiserror::Error)]
158#[non_exhaustive]
159pub enum VoipVersionIdError {
160    /// The value of the `UInt` is not 0.
161    #[error("UInt value is not 0")]
162    WrongUintValue,
163}
164
165#[cfg(test)]
166mod tests {
167    use std::mem::size_of;
168
169    use super::Error;
170
171    #[test]
172    fn small_error_type() {
173        assert!(size_of::<Error>() <= 8);
174    }
175}
ruma_identifiers_validation/error.rs

ruma_identifiers_validation/
error.rs
