From 52268b5dc207fe56f72f1595d5e9c59cea23c25d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Fri, 18 Feb 2022 14:38:29 +0100 Subject: [PATCH] identifiers: Rename MatrixToRef to matrix_uri::MatrixToUri --- crates/ruma-identifiers/src/lib.rs | 4 ++-- .../src/{matrix_to.rs => matrix_uri.rs} | 10 ++++++---- crates/ruma-identifiers/src/room_alias_id.rs | 10 +++++----- crates/ruma-identifiers/src/room_id.rs | 10 +++++----- crates/ruma-identifiers/src/user_id.rs | 6 +++--- 5 files changed, 21 insertions(+), 19 deletions(-) rename crates/ruma-identifiers/src/{matrix_to.rs => matrix_uri.rs} (93%) diff --git a/crates/ruma-identifiers/src/lib.rs b/crates/ruma-identifiers/src/lib.rs index 08627820..bb80d87c 100644 --- a/crates/ruma-identifiers/src/lib.rs +++ b/crates/ruma-identifiers/src/lib.rs @@ -32,7 +32,7 @@ pub use crate::{ event_id::EventId, key_id::{DeviceSigningKeyId, KeyId, ServerSigningKeyId, SigningKeyId}, key_name::KeyName, - matrix_to::MatrixToRef, + matrix_uri::MatrixToUri, mxc_uri::MxcUri, room_alias_id::RoomAliasId, room_id::RoomId, @@ -51,6 +51,7 @@ pub use ruma_identifiers_validation::error::Error; #[macro_use] mod macros; +pub mod matrix_uri; pub mod user_id; mod client_secret; @@ -60,7 +61,6 @@ mod device_key_id; mod event_id; mod key_id; mod key_name; -mod matrix_to; mod mxc_uri; mod room_alias_id; mod room_id; diff --git a/crates/ruma-identifiers/src/matrix_to.rs b/crates/ruma-identifiers/src/matrix_uri.rs similarity index 93% rename from crates/ruma-identifiers/src/matrix_to.rs rename to crates/ruma-identifiers/src/matrix_uri.rs index 50cb8c06..e95d8fbf 100644 --- a/crates/ruma-identifiers/src/matrix_to.rs +++ b/crates/ruma-identifiers/src/matrix_uri.rs @@ -1,3 +1,5 @@ +//! Matrix URIs. + use std::fmt; use percent_encoding::{percent_encode, AsciiSet, CONTROLS}; @@ -33,13 +35,13 @@ const TO_ENCODE: &AsciiSet = &CONTROLS /// Turn it into a `matrix.to` URL through its `Display` implementation (i.e. by /// interpolating it in a formatting macro or via `.to_string()`). #[derive(Debug, PartialEq, Eq)] -pub struct MatrixToRef<'a> { +pub struct MatrixToUri<'a> { id: &'a str, event_id: Option<&'a EventId>, via: Vec<&'a ServerName>, } -impl<'a> MatrixToRef<'a> { +impl<'a> MatrixToUri<'a> { pub(crate) fn new(id: &'a str, via: Vec<&'a ServerName>) -> Self { Self { id, event_id: None, via } } @@ -49,7 +51,7 @@ impl<'a> MatrixToRef<'a> { } } -impl<'a> fmt::Display for MatrixToRef<'a> { +impl<'a> fmt::Display for MatrixToUri<'a> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.write_str(BASE_URL)?; write!(f, "{}", percent_encode(self.id.as_bytes(), TO_ENCODE))?; @@ -75,7 +77,7 @@ mod tests { use crate::user_id; #[test] - fn matrix_to_ref() { + fn matrix_to_uri() { assert_eq!( user_id!("@jplatte:notareal.hs").matrix_to_url().to_string(), "https://matrix.to/#/%40jplatte%3Anotareal.hs" diff --git a/crates/ruma-identifiers/src/room_alias_id.rs b/crates/ruma-identifiers/src/room_alias_id.rs index dece33cc..a0764e13 100644 --- a/crates/ruma-identifiers/src/room_alias_id.rs +++ b/crates/ruma-identifiers/src/room_alias_id.rs @@ -1,6 +1,6 @@ //! Matrix room alias identifiers. -use crate::{server_name::ServerName, EventId, MatrixToRef}; +use crate::{server_name::ServerName, EventId, MatrixToUri}; /// A Matrix room alias ID. /// @@ -30,13 +30,13 @@ impl RoomAliasId { } /// Create a `matrix.to` reference for this room alias ID. - pub fn matrix_to_url(&self) -> MatrixToRef<'_> { - MatrixToRef::new(self.as_str(), Vec::new()) + pub fn matrix_to_url(&self) -> MatrixToUri<'_> { + MatrixToUri::new(self.as_str(), Vec::new()) } /// Create a `matrix.to` reference for an event scoped under this room alias ID. - pub fn matrix_to_event_url<'a>(&'a self, ev_id: &'a EventId) -> MatrixToRef<'a> { - MatrixToRef::event(self.as_str(), ev_id, Vec::new()) + pub fn matrix_to_event_url<'a>(&'a self, ev_id: &'a EventId) -> MatrixToUri<'a> { + MatrixToUri::event(self.as_str(), ev_id, Vec::new()) } fn colon_idx(&self) -> usize { diff --git a/crates/ruma-identifiers/src/room_id.rs b/crates/ruma-identifiers/src/room_id.rs index e0bc13cc..7a71fb00 100644 --- a/crates/ruma-identifiers/src/room_id.rs +++ b/crates/ruma-identifiers/src/room_id.rs @@ -1,6 +1,6 @@ //! Matrix room identifiers. -use crate::{EventId, MatrixToRef, ServerName}; +use crate::{EventId, MatrixToUri, ServerName}; /// A Matrix room ID. /// @@ -55,13 +55,13 @@ impl RoomId { pub fn matrix_to_url<'a>( &'a self, via: impl IntoIterator, - ) -> MatrixToRef<'a> { - MatrixToRef::new(self.as_str(), via.into_iter().collect()) + ) -> MatrixToUri<'a> { + MatrixToUri::new(self.as_str(), via.into_iter().collect()) } /// Create a `matrix.to` reference for an event scoped under this room ID. - pub fn matrix_to_event_url<'a>(&'a self, ev_id: &'a EventId) -> MatrixToRef<'a> { - MatrixToRef::event(self.as_str(), ev_id, Vec::new()) + pub fn matrix_to_event_url<'a>(&'a self, ev_id: &'a EventId) -> MatrixToUri<'a> { + MatrixToUri::event(self.as_str(), ev_id, Vec::new()) } fn colon_idx(&self) -> usize { diff --git a/crates/ruma-identifiers/src/user_id.rs b/crates/ruma-identifiers/src/user_id.rs index a40d1d28..a6f62dc1 100644 --- a/crates/ruma-identifiers/src/user_id.rs +++ b/crates/ruma-identifiers/src/user_id.rs @@ -2,7 +2,7 @@ use std::{rc::Rc, sync::Arc}; -use crate::{MatrixToRef, ServerName}; +use crate::{MatrixToUri, ServerName}; /// A Matrix user ID. /// @@ -116,8 +116,8 @@ impl UserId { /// display_name = "jplatte", /// ); /// ``` - pub fn matrix_to_url(&self) -> MatrixToRef<'_> { - MatrixToRef::new(self.as_str(), Vec::new()) + pub fn matrix_to_url(&self) -> MatrixToUri<'_> { + MatrixToUri::new(self.as_str(), Vec::new()) } fn colon_idx(&self) -> usize {