feat: Allow usage of MagnetLink in sea_orm::Model

Author: angrynode

Cargo.toml

@@ -26,13 +26,17 @@ sha256 = "1.5"
 rustc-hex = "2.1"
 serde = { version = "1", features = [ "derive" ] }
 fluent-uri = { version = "0.4", features = [ "serde" ] }
+# For Sea-ORM integration
+sea-orm = { version = "2.0.0-rc.18", optional = true }
 
 [dev-dependencies]
 serde_json = "1"
 
 [features]
 magnet_force_name = []
 unknown_tracker_scheme = []
+sea_orm = [ "dep:sea-orm" ]
+test_sea_orm = [ "dep:sea-orm", "sea-orm/sqlx-sqlite" ]
 
 [[test]]
 name = "magnet_force_name"
@@ -45,3 +49,9 @@ name = "unknown_tracker_scheme"
 path = "tests/unknown_tracker_scheme.rs"
 required-features = [ "unknown_tracker_scheme" ]
 test = true
+
+[[test]]
+name = "sea_orm"
+path = "tests/sea_orm.rs"
+required-features = [ "sea_orm" ]
+test = true

src/magnet.rs

@@ -119,6 +119,8 @@ impl std::error::Error for MagnetLinkError {
 /// More information is specified in [BEP-0009](https://bittorrent.org/beps/bep_0009.html), and
 /// even more appears in the wild, as explained [on Wikipedia](https://en.wikipedia.org/wiki/Magnet_URI_scheme).
 #[derive(Clone, Debug)]
+// #[derive(sea_orm::DeriveValueType)]
+// #[sea_orm(value_type = "String")]
 pub struct MagnetLink {
     /// Only mandatory field for magnet link parsing, unless the
     /// `magnet_force_name` crate feature is enabled.
@@ -322,6 +324,70 @@ impl std::fmt::Display for MagnetLink {
     }
 }
 
+impl PartialEq for MagnetLink {
+    fn eq(&self, other: &Self) -> bool {
+        self.query == other.query
+    }
+}
+
+#[cfg(feature = "sea_orm")]
+impl From<MagnetLink> for sea_orm::sea_query::Value {
+    fn from(m: MagnetLink) -> Self {
+        Self::String(Some(m.to_string()))
+    }
+}
+
+#[cfg(feature = "sea_orm")]
+impl sea_orm::TryGetable for MagnetLink {
+    fn try_get_by<I: sea_orm::ColIdx>(
+        res: &sea_orm::QueryResult,
+        index: I,
+    ) -> Result<Self, sea_orm::error::TryGetError> {
+        let val: String = res.try_get_by(index)?;
+        MagnetLink::new(&val).map_err(|e| {
+            sea_orm::error::TryGetError::DbErr(sea_orm::DbErr::TryIntoErr {
+                from: "String",
+                into: "MagnetLink",
+                source: std::sync::Arc::new(e),
+            })
+        })
+    }
+}
+
+#[cfg(feature = "sea_orm")]
+impl sea_orm::sea_query::ValueType for MagnetLink {
+    fn try_from(v: sea_orm::Value) -> Result<Self, sea_orm::sea_query::ValueTypeErr> {
+        match v {
+            // TODO: What to do with None String?
+            // This should probably work with Option<MagnetLink> but not with MagnetLink
+            // but i have no idea how sea orm works...
+            sea_orm::Value::String(Some(s)) => {
+                MagnetLink::new(&s).map_err(|_e| sea_orm::sea_query::ValueTypeErr)
+            }
+            _ => Err(sea_orm::sea_query::ValueTypeErr),
+        }
+    }
+
+    fn type_name() -> String {
+        "MagnetLink".to_string()
+    }
+
+    fn array_type() -> sea_orm::sea_query::ArrayType {
+        sea_orm::sea_query::ArrayType::String
+    }
+
+    fn column_type() -> sea_orm::sea_query::ColumnType {
+        sea_orm::sea_query::ColumnType::String(sea_orm::sea_query::table::StringLen::None)
+    }
+}
+
+#[cfg(feature = "sea_orm")]
+impl sea_orm::sea_query::Nullable for MagnetLink {
+    fn null() -> sea_orm::sea_query::Value {
+        sea_orm::sea_query::Value::String(None)
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

tests/sea_orm.rs

@@ -0,0 +1,19 @@
+use hightorrent::MagnetLink;
+use sea_orm::entity::prelude::*;
+
+#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
+#[sea_orm(table_name = "magnet")]
+pub struct Model {
+    #[sea_orm(primary_key)]
+    pub id: i32,
+    pub torrent_id: String,
+    pub magnet: MagnetLink,
+    pub name: String,
+    pub resolved: bool,
+}
+
+#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+pub enum Relation {}
+
+#[async_trait::async_trait]
+impl ActiveModelBehavior for ActiveModel {}