83de77f002
git-subtree-dir: ruma-identifiers git-subtree-mainline: 19ce9645b6651e4de42ddf9e81ee50e19c8c0f26 git-subtree-split: c0a1d8bd440c7cde0fa4ab5e22898ddb26bb706d
55 lines
2.3 KiB
Rust
55 lines
2.3 KiB
Rust
//! Error conditions.
|
|
|
|
use std::fmt::{self, Display, Formatter};
|
|
|
|
/// An error encountered when trying to parse an invalid ID string.
|
|
#[derive(Copy, Clone, Debug, Eq, Hash, PartialEq)]
|
|
pub enum Error {
|
|
/// The ID's localpart contains invalid characters.
|
|
///
|
|
/// Only relevant for user IDs.
|
|
InvalidCharacters,
|
|
/// The key version contains outside of [a-zA-Z0-9_].
|
|
InvalidKeyVersion,
|
|
/// The localpart of the ID string is not valid (because it is empty).
|
|
InvalidLocalPart,
|
|
/// The server name part of the the ID string is not a valid server name.
|
|
InvalidServerName,
|
|
/// The ID exceeds 255 bytes (or 32 codepoints for a room version ID.)
|
|
MaximumLengthExceeded,
|
|
/// The ID is less than 4 characters (or is an empty room version ID.)
|
|
MinimumLengthNotSatisfied,
|
|
/// The ID is missing the colon delimiter between localpart and server name.
|
|
MissingDelimiter,
|
|
/// The ID is missing the colon delimiter between key algorithm and device ID.
|
|
MissingDeviceKeyDelimiter,
|
|
/// The ID is missing the colon delimiter between key algorithm and version.
|
|
MissingServerKeyDelimiter,
|
|
/// The ID is missing the leading sigil.
|
|
MissingSigil,
|
|
/// The key algorithm is not recognized.
|
|
UnknownKeyAlgorithm,
|
|
}
|
|
|
|
impl Display for Error {
|
|
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
|
|
let message = match self {
|
|
Error::InvalidCharacters => "localpart contains invalid characters",
|
|
Error::InvalidKeyVersion => "key id version contains invalid characters",
|
|
Error::InvalidLocalPart => "localpart is empty",
|
|
Error::InvalidServerName => "server name is not a valid IP address or domain name",
|
|
Error::MaximumLengthExceeded => "ID exceeds 255 bytes",
|
|
Error::MinimumLengthNotSatisfied => "ID must be at least 4 characters",
|
|
Error::MissingDelimiter => "colon is required between localpart and server name",
|
|
Error::MissingDeviceKeyDelimiter => "colon is required between algorithm and device ID",
|
|
Error::MissingServerKeyDelimiter => "colon is required between algorithm and version",
|
|
Error::MissingSigil => "leading sigil is missing",
|
|
Error::UnknownKeyAlgorithm => "unknown key algorithm specified",
|
|
};
|
|
|
|
write!(f, "{}", message)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for Error {}
|