119 lines
3.3 KiB
Rust
119 lines
3.3 KiB
Rust
//! A URI that should be a Matrix-spec compliant [MXC URI].
|
|
//!
|
|
//! [MXC URI]: https://matrix.org/docs/spec/client_server/r0.6.1#mxc-uri
|
|
|
|
use std::num::NonZeroU8;
|
|
|
|
use ruma_identifiers_validation::{error::MxcUriError, mxc_uri::validate};
|
|
|
|
use crate::ServerName;
|
|
|
|
type Result<T, E = MxcUriError> = std::result::Result<T, E>;
|
|
|
|
/// A URI that should be a Matrix-spec compliant [MXC URI].
|
|
///
|
|
/// [MXC URI]: https://matrix.org/docs/spec/client_server/r0.6.1#mxc-uri
|
|
|
|
#[repr(transparent)]
|
|
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash)]
|
|
pub struct MxcUri(str);
|
|
|
|
opaque_identifier!(MxcUri);
|
|
|
|
impl MxcUri {
|
|
/// If this is a valid MXC URI, returns the media ID.
|
|
pub fn media_id(&self) -> Result<&str> {
|
|
self.parts().map(|(_, s)| s)
|
|
}
|
|
|
|
/// If this is a valid MXC URI, returns the server name.
|
|
pub fn server_name(&self) -> Result<&ServerName> {
|
|
self.parts().map(|(s, _)| s)
|
|
}
|
|
|
|
/// If this is a valid MXC URI, returns a `(server_name, media_id)` tuple, else it returns the
|
|
/// error.
|
|
pub fn parts(&self) -> Result<(&ServerName, &str)> {
|
|
self.extract_slash_idx().map(|idx| {
|
|
(
|
|
ServerName::from_borrowed(&self.as_str()[6..idx.get() as usize]),
|
|
&self.as_str()[idx.get() as usize + 1..],
|
|
)
|
|
})
|
|
}
|
|
|
|
/// Validates the URI and returns an error if it failed.
|
|
pub fn validate(&self) -> Result<()> {
|
|
self.extract_slash_idx().map(|_| ())
|
|
}
|
|
|
|
/// Convenience method for `.validate().is_ok()`.
|
|
#[inline(always)]
|
|
pub fn is_valid(&self) -> bool {
|
|
self.validate().is_ok()
|
|
}
|
|
|
|
// convenience method for calling validate(self)
|
|
#[inline(always)]
|
|
fn extract_slash_idx(&self) -> Result<NonZeroU8> {
|
|
validate(self.as_str())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::convert::TryInto;
|
|
|
|
use ruma_identifiers_validation::error::MxcUriError;
|
|
|
|
use super::MxcUri;
|
|
|
|
#[test]
|
|
fn parse_mxc_uri() {
|
|
let mxc = Box::<MxcUri>::from("mxc://127.0.0.1/asd32asdfasdsd");
|
|
|
|
assert!(mxc.is_valid());
|
|
assert_eq!(
|
|
mxc.parts(),
|
|
Ok(("127.0.0.1".try_into().expect("Failed to create ServerName"), "asd32asdfasdsd"))
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn parse_mxc_uri_without_media_id() {
|
|
let mxc = Box::<MxcUri>::from("mxc://127.0.0.1");
|
|
|
|
assert!(!mxc.is_valid());
|
|
assert_eq!(mxc.parts(), Err(MxcUriError::MissingSlash));
|
|
}
|
|
|
|
#[test]
|
|
fn parse_mxc_uri_without_protocol() {
|
|
assert!(!Box::<MxcUri>::from("127.0.0.1/asd32asdfasdsd").is_valid());
|
|
}
|
|
|
|
#[cfg(feature = "serde")]
|
|
#[test]
|
|
fn serialize_mxc_uri() {
|
|
assert_eq!(
|
|
serde_json::to_string(&Box::<MxcUri>::from("mxc://server/1234id"))
|
|
.expect("Failed to convert MxcUri to JSON."),
|
|
r#""mxc://server/1234id""#
|
|
);
|
|
}
|
|
|
|
#[cfg(feature = "serde")]
|
|
#[test]
|
|
fn deserialize_mxc_uri() {
|
|
let mxc = serde_json::from_str::<Box<MxcUri>>(r#""mxc://server/1234id""#)
|
|
.expect("Failed to convert JSON to MxcUri");
|
|
|
|
assert_eq!(mxc.as_str(), "mxc://server/1234id");
|
|
assert!(mxc.is_valid());
|
|
assert_eq!(
|
|
mxc.parts(),
|
|
Ok(("server".try_into().expect("Failed to create ServerName"), "1234id"))
|
|
);
|
|
}
|
|
}
|