//! Matrix room alias identifiers. use std::{convert::TryFrom, fmt, num::NonZeroU8}; use crate::server_name::ServerName; /// A Matrix room alias ID. /// /// A `RoomAliasId` is converted from a string slice, and can be converted back into a string as /// needed. /// /// ``` /// # use std::convert::TryFrom; /// # use ruma_identifiers::RoomAliasId; /// assert_eq!( /// RoomAliasId::try_from("#ruma:example.com").unwrap().as_ref(), /// "#ruma:example.com" /// ); /// ``` #[derive(Clone)] pub struct RoomAliasId { pub(crate) full_id: Box, pub(crate) colon_idx: NonZeroU8, } impl fmt::Debug for RoomAliasId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str(&self.full_id) } } impl RoomAliasId { /// Returns the room's alias. pub fn alias(&self) -> &str { &self.full_id[1..self.colon_idx.get() as usize] } /// Returns the server name of the room alias ID. pub fn server_name(&self) -> &ServerName { <&ServerName>::try_from(&self.full_id[self.colon_idx.get() as usize + 1..]).unwrap() } } /// Attempts to create a new Matrix room alias ID from a string representation. /// /// The string must include the leading # sigil, the alias, a literal colon, and a server name. fn try_from(room_alias_id: S) -> Result where S: AsRef + Into>, { let colon_idx = ruma_identifiers_validation::room_alias_id::validate(room_alias_id.as_ref())?; Ok(RoomAliasId { full_id: room_alias_id.into(), colon_idx }) } common_impls!(RoomAliasId, try_from, "a Matrix room alias ID"); #[cfg(test)] mod tests { use std::convert::TryFrom; use super::RoomAliasId; use crate::Error; #[test] fn valid_room_alias_id() { assert_eq!( RoomAliasId::try_from("#ruma:example.com") .expect("Failed to create RoomAliasId.") .as_ref(), "#ruma:example.com" ); } #[test] fn empty_localpart() { assert_eq!( RoomAliasId::try_from("#:myhomeserver.io") .expect("Failed to create RoomAliasId.") .as_ref(), "#:myhomeserver.io" ); } #[cfg(feature = "serde")] #[test] fn serialize_valid_room_alias_id() { assert_eq!( serde_json::to_string( &RoomAliasId::try_from("#ruma:example.com").expect("Failed to create RoomAliasId.") ) .expect("Failed to convert RoomAliasId to JSON."), r##""#ruma:example.com""## ); } #[cfg(feature = "serde")] #[test] fn deserialize_valid_room_alias_id() { assert_eq!( serde_json::from_str::(r##""#ruma:example.com""##) .expect("Failed to convert JSON to RoomAliasId"), RoomAliasId::try_from("#ruma:example.com").expect("Failed to create RoomAliasId.") ); } #[test] fn valid_room_alias_id_with_explicit_standard_port() { assert_eq!( RoomAliasId::try_from("#ruma:example.com:443") .expect("Failed to create RoomAliasId.") .as_ref(), "#ruma:example.com:443" ); } #[test] fn valid_room_alias_id_with_non_standard_port() { assert_eq!( RoomAliasId::try_from("#ruma:example.com:5000") .expect("Failed to create RoomAliasId.") .as_ref(), "#ruma:example.com:5000" ); } #[test] fn valid_room_alias_id_unicode() { assert_eq!( RoomAliasId::try_from("#老虎£я:example.com") .expect("Failed to create RoomAliasId.") .as_ref(), "#老虎£я:example.com" ); } #[test] fn missing_room_alias_id_sigil() { assert_eq!( RoomAliasId::try_from("39hvsi03hlne:example.com").unwrap_err(), Error::MissingLeadingSigil ); } #[test] fn missing_room_alias_id_delimiter() { assert_eq!(RoomAliasId::try_from("#ruma").unwrap_err(), Error::MissingDelimiter); } #[test] fn invalid_leading_sigil() { assert_eq!( RoomAliasId::try_from("!room_id:foo.bar").unwrap_err(), Error::MissingLeadingSigil ); } #[test] fn invalid_room_alias_id_host() { assert_eq!(RoomAliasId::try_from("#ruma:/").unwrap_err(), Error::InvalidServerName); } #[test] fn invalid_room_alias_id_port() { assert_eq!( RoomAliasId::try_from("#ruma:example.com:notaport").unwrap_err(), Error::InvalidServerName ); } }