From 02d09e3f0c334d979d497bb2474fed36c149e137 Mon Sep 17 00:00:00 2001
From: Devon Hudson <devon.dmytro@gmail.com>
Date: Thu, 5 Dec 2024 15:41:57 +0000
Subject: [PATCH] Add RoomID & EventID rust types (#17996)
Adds the RoomID & EventID rust types to the rust lib.
Also adds a Deserialize impl to the existing UserID type.
### Pull Request Checklist
<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->
* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
The entry should:
- Be a short description of your change which makes sense to users.
"Fixed a bug that prevented receiving messages from other servers."
instead of "Moved X method from `EventStore` to `EventWorkerStore`.".
- Use markdown where necessary, mostly for `code blocks`.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by
@github_username." or "Contributed by [Your Name]." to the end of the
entry.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
---
changelog.d/17996.misc | 1 +
rust/src/identifier.rs | 166 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 167 insertions(+)
create mode 100644 changelog.d/17996.misc
diff --git a/changelog.d/17996.misc b/changelog.d/17996.misc
new file mode 100644
index 0000000000..8664ee45ae
--- /dev/null
+++ b/changelog.d/17996.misc
@@ -0,0 +1 @@
+Add `RoomID` & `EventID` rust types.
diff --git a/rust/src/identifier.rs b/rust/src/identifier.rs
index b199c5838e..b70f6a30c7 100644
--- a/rust/src/identifier.rs
+++ b/rust/src/identifier.rs
@@ -71,6 +71,34 @@ impl TryFrom<&str> for UserID {
}
}
+impl TryFrom<String> for UserID {
+ type Error = IdentifierError;
+
+ /// Will try creating a `UserID` from the provided `&str`.
+ /// Can fail if the user_id is incorrectly formatted.
+ fn try_from(s: String) -> Result<Self, Self::Error> {
+ if !s.starts_with('@') {
+ return Err(IdentifierError::IncorrectSigil);
+ }
+
+ if s.find(':').is_none() {
+ return Err(IdentifierError::MissingColon);
+ }
+
+ Ok(UserID(s))
+ }
+}
+
+impl<'de> serde::Deserialize<'de> for UserID {
+ fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ let s: String = serde::Deserialize::deserialize(deserializer)?;
+ UserID::try_from(s).map_err(serde::de::Error::custom)
+ }
+}
+
impl Deref for UserID {
type Target = str;
@@ -84,3 +112,141 @@ impl fmt::Display for UserID {
write!(f, "{}", self.0)
}
}
+
+/// A Matrix room_id.
+#[derive(Clone, Debug, PartialEq)]
+pub struct RoomID(String);
+
+impl RoomID {
+ /// Returns the `localpart` of the room_id.
+ pub fn localpart(&self) -> &str {
+ &self[1..self.colon_pos()]
+ }
+
+ /// Returns the `server_name` / `domain` of the room_id.
+ pub fn server_name(&self) -> &str {
+ &self[self.colon_pos() + 1..]
+ }
+
+ /// Returns the position of the ':' inside of the room_id.
+ /// Used when splitting the room_id into it's respective parts.
+ fn colon_pos(&self) -> usize {
+ self.find(':').unwrap()
+ }
+}
+
+impl TryFrom<&str> for RoomID {
+ type Error = IdentifierError;
+
+ /// Will try creating a `RoomID` from the provided `&str`.
+ /// Can fail if the room_id is incorrectly formatted.
+ fn try_from(s: &str) -> Result<Self, Self::Error> {
+ if !s.starts_with('!') {
+ return Err(IdentifierError::IncorrectSigil);
+ }
+
+ if s.find(':').is_none() {
+ return Err(IdentifierError::MissingColon);
+ }
+
+ Ok(RoomID(s.to_string()))
+ }
+}
+
+impl TryFrom<String> for RoomID {
+ type Error = IdentifierError;
+
+ /// Will try creating a `RoomID` from the provided `String`.
+ /// Can fail if the room_id is incorrectly formatted.
+ fn try_from(s: String) -> Result<Self, Self::Error> {
+ if !s.starts_with('!') {
+ return Err(IdentifierError::IncorrectSigil);
+ }
+
+ if s.find(':').is_none() {
+ return Err(IdentifierError::MissingColon);
+ }
+
+ Ok(RoomID(s))
+ }
+}
+
+impl<'de> serde::Deserialize<'de> for RoomID {
+ fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ let s: String = serde::Deserialize::deserialize(deserializer)?;
+ RoomID::try_from(s).map_err(serde::de::Error::custom)
+ }
+}
+
+impl Deref for RoomID {
+ type Target = str;
+
+ fn deref(&self) -> &Self::Target {
+ &self.0
+ }
+}
+
+impl fmt::Display for RoomID {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}", self.0)
+ }
+}
+
+/// A Matrix event_id.
+#[derive(Clone, Debug, PartialEq)]
+pub struct EventID(String);
+
+impl TryFrom<&str> for EventID {
+ type Error = IdentifierError;
+
+ /// Will try creating a `EventID` from the provided `&str`.
+ /// Can fail if the event_id is incorrectly formatted.
+ fn try_from(s: &str) -> Result<Self, Self::Error> {
+ if !s.starts_with('$') {
+ return Err(IdentifierError::IncorrectSigil);
+ }
+
+ Ok(EventID(s.to_string()))
+ }
+}
+
+impl TryFrom<String> for EventID {
+ type Error = IdentifierError;
+
+ /// Will try creating a `EventID` from the provided `String`.
+ /// Can fail if the event_id is incorrectly formatted.
+ fn try_from(s: String) -> Result<Self, Self::Error> {
+ if !s.starts_with('$') {
+ return Err(IdentifierError::IncorrectSigil);
+ }
+
+ Ok(EventID(s))
+ }
+}
+
+impl<'de> serde::Deserialize<'de> for EventID {
+ fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ let s: String = serde::Deserialize::deserialize(deserializer)?;
+ EventID::try_from(s).map_err(serde::de::Error::custom)
+ }
+}
+
+impl Deref for EventID {
+ type Target = str;
+
+ fn deref(&self) -> &Self::Target {
+ &self.0
+ }
+}
+
+impl fmt::Display for EventID {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}", self.0)
+ }
+}
--
GitLab