ruma_common/identifiers/
device_id.rs

Help
1use ruma_macros::IdZst;
2
3#[cfg(feature = "rand")]
4use super::generate_localpart;
5use super::{IdParseError, KeyName};
6
7/// A Matrix device ID.
8///
9/// Device identifiers in Matrix are completely opaque character sequences. This type is provided
10/// simply for its semantic value.
11///
12/// # Example
13///
14/// ```
15/// use ruma_common::{device_id, DeviceId, OwnedDeviceId};
16///
17/// # #[cfg(feature = "rand")] {
18/// let random_id = DeviceId::new();
19/// assert_eq!(random_id.as_str().len(), 10);
20/// # }
21///
22/// let static_id = device_id!("01234567");
23/// assert_eq!(static_id.as_str(), "01234567");
24///
25/// let ref_id: &DeviceId = "abcdefghi".into();
26/// assert_eq!(ref_id.as_str(), "abcdefghi");
27///
28/// let owned_id: OwnedDeviceId = "ijklmnop".into();
29/// assert_eq!(owned_id.as_str(), "ijklmnop");
30/// ```
31#[repr(transparent)]
32#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, IdZst)]
33pub struct DeviceId(str);
34
35impl DeviceId {
36    /// Generates a random `DeviceId`, suitable for assignment to a new device.
37    #[cfg(feature = "rand")]
38    #[allow(clippy::new_ret_no_self)]
39    pub fn new() -> OwnedDeviceId {
40        Self::from_borrowed(&generate_localpart(10)).to_owned()
41    }
42}
43
44impl KeyName for DeviceId {
45    fn validate(_s: &str) -> Result<(), IdParseError> {
46        Ok(())
47    }
48}
49
50impl KeyName for OwnedDeviceId {
51    fn validate(_s: &str) -> Result<(), IdParseError> {
52        Ok(())
53    }
54}
55
56#[cfg(test)]
57mod tests {
58    use super::{DeviceId, OwnedDeviceId};
59
60    #[cfg(feature = "rand")]
61    #[test]
62    fn generate_device_id() {
63        assert_eq!(DeviceId::new().as_str().len(), 10);
64    }
65
66    #[test]
67    fn create_device_id_from_str() {
68        let ref_id: &DeviceId = "abcdefgh".into();
69        assert_eq!(ref_id.as_str(), "abcdefgh");
70    }
71
72    #[test]
73    fn create_boxed_device_id_from_str() {
74        let box_id: OwnedDeviceId = "12345678".into();
75        assert_eq!(box_id.as_str(), "12345678");
76    }
77
78    #[test]
79    fn create_device_id_from_box() {
80        let box_str: Box<str> = "ijklmnop".into();
81        let device_id: OwnedDeviceId = box_str.into();
82        assert_eq!(device_id.as_str(), "ijklmnop");
83    }
84}
ruma_common/identifiers/device_id.rs

ruma_common/identifiers/
device_id.rs
