ruma_common/identifiers/
mxc_uri.rs

Help
1//! A URI that should be a Matrix-spec compliant [MXC URI].
2//!
3//! [MXC URI]: https://spec.matrix.org/latest/client-server-api/#matrix-content-mxc-uris
4
5use std::num::NonZeroU8;
6
7use ruma_identifiers_validation::{error::MxcUriError, mxc_uri::validate};
8use ruma_macros::IdZst;
9
10use super::ServerName;
11
12type Result<T, E = MxcUriError> = std::result::Result<T, E>;
13
14/// A URI that should be a Matrix-spec compliant [MXC URI].
15///
16/// [MXC URI]: https://spec.matrix.org/latest/client-server-api/#matrix-content-mxc-uris
17#[repr(transparent)]
18#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, IdZst)]
19pub struct MxcUri(str);
20
21impl MxcUri {
22    /// If this is a valid MXC URI, returns the media ID.
23    pub fn media_id(&self) -> Result<&str> {
24        self.parts().map(|(_, s)| s)
25    }
26
27    /// If this is a valid MXC URI, returns the server name.
28    pub fn server_name(&self) -> Result<&ServerName> {
29        self.parts().map(|(s, _)| s)
30    }
31
32    /// If this is a valid MXC URI, returns a `(server_name, media_id)` tuple, else it returns the
33    /// error.
34    pub fn parts(&self) -> Result<(&ServerName, &str)> {
35        self.extract_slash_idx().map(|idx| {
36            (
37                ServerName::from_borrowed(&self.as_str()[6..idx.get() as usize]),
38                &self.as_str()[idx.get() as usize + 1..],
39            )
40        })
41    }
42
43    /// Validates the URI and returns an error if it failed.
44    pub fn validate(&self) -> Result<()> {
45        self.extract_slash_idx().map(|_| ())
46    }
47
48    /// Convenience method for `.validate().is_ok()`.
49    #[inline(always)]
50    pub fn is_valid(&self) -> bool {
51        self.validate().is_ok()
52    }
53
54    // convenience method for calling validate(self)
55    #[inline(always)]
56    fn extract_slash_idx(&self) -> Result<NonZeroU8> {
57        validate(self.as_str())
58    }
59}
60
61#[cfg(test)]
62mod tests {
63    use ruma_identifiers_validation::error::MxcUriError;
64
65    use super::{MxcUri, OwnedMxcUri};
66
67    #[test]
68    fn parse_mxc_uri() {
69        let mxc = Box::<MxcUri>::from("mxc://127.0.0.1/asd32asdfasdsd");
70
71        assert!(mxc.is_valid());
72        assert_eq!(
73            mxc.parts(),
74            Ok(("127.0.0.1".try_into().expect("Failed to create ServerName"), "asd32asdfasdsd"))
75        );
76    }
77
78    #[test]
79    fn parse_mxc_uri_without_media_id() {
80        let mxc = Box::<MxcUri>::from("mxc://127.0.0.1");
81
82        assert!(!mxc.is_valid());
83        assert_eq!(mxc.parts(), Err(MxcUriError::MissingSlash));
84    }
85
86    #[test]
87    fn parse_mxc_uri_without_protocol() {
88        assert!(!Box::<MxcUri>::from("127.0.0.1/asd32asdfasdsd").is_valid());
89    }
90
91    #[test]
92    fn serialize_mxc_uri() {
93        assert_eq!(
94            serde_json::to_string(&Box::<MxcUri>::from("mxc://server/1234id"))
95                .expect("Failed to convert MxcUri to JSON."),
96            r#""mxc://server/1234id""#
97        );
98    }
99
100    #[test]
101    fn deserialize_mxc_uri() {
102        let mxc = serde_json::from_str::<OwnedMxcUri>(r#""mxc://server/1234id""#)
103            .expect("Failed to convert JSON to MxcUri");
104
105        assert_eq!(mxc.as_str(), "mxc://server/1234id");
106        assert!(mxc.is_valid());
107        assert_eq!(
108            mxc.parts(),
109            Ok(("server".try_into().expect("Failed to create ServerName"), "1234id"))
110        );
111    }
112}
ruma_common/identifiers/mxc_uri.rs

ruma_common/identifiers/
mxc_uri.rs
