feat(core/database): add Reference struct

crates/core/database/Cargo.toml

@@ -14,6 +14,7 @@ mongodb = [ "dep:mongodb" ]
 
 # ... Other
 async-std-runtime = [ "async-std" ]
+rocket-impl = [ "rocket", "schemars" ]
 
 # Default Features
 default = [ "mongodb", "async-std-runtime" ]
@@ -42,5 +43,9 @@ async-recursion = "1.0.4"
 # Async
 async-std = { version = "1.8.0", features = ["attributes"], optional = true }
 
+# Rocket Impl
+schemars = { version = "0.8.8", optional = true }
+rocket = { version = "0.5.0-rc.2", default-features = false, features = ["json"], optional = true }
+
 # Authifier
 authifier = { version = "1.0" }

crates/core/database/src/lib.rs

@@ -73,6 +73,7 @@ macro_rules! database_test {
 }
 
 mod models;
+pub mod util;
 pub use models::*;
 
 /// Utility function to check if a boolean value is false

crates/core/database/src/util/mod.rs

@@ -0,0 +1 @@
+pub mod reference;

crates/core/database/src/util/reference.rs

@@ -0,0 +1,52 @@
+use revolt_result::Result;
+#[cfg(feature = "rocket-impl")]
+use rocket::request::FromParam;
+#[cfg(feature = "rocket-impl")]
+use schemars::{
+    schema::{InstanceType, Schema, SchemaObject, SingleOrVec},
+    JsonSchema,
+};
+
+use crate::{Bot, Database};
+
+/// Reference to some object in the database
+#[derive(Serialize, Deserialize)]
+pub struct Reference {
+    /// Id of object
+    pub id: String,
+}
+
+impl Reference {
+    /// Create a Ref from an unchecked string
+    pub fn from_unchecked(id: String) -> Reference {
+        Reference { id }
+    }
+
+    /// Fetch bot from Ref
+    pub async fn as_bot(&self, db: &Database) -> Result<Bot> {
+        db.fetch_bot(&self.id).await
+    }
+}
+
+#[cfg(feature = "rocket-impl")]
+impl<'r> FromParam<'r> for Reference {
+    type Error = &'r str;
+
+    fn from_param(param: &'r str) -> Result<Self, Self::Error> {
+        Ok(Reference::from_unchecked(param.into()))
+    }
+}
+
+#[cfg(feature = "rocket-impl")]
+impl JsonSchema for Reference {
+    fn schema_name() -> String {
+        "Id".to_string()
+    }
+
+    fn json_schema(_gen: &mut schemars::gen::SchemaGenerator) -> Schema {
+        Schema::Object(SchemaObject {
+            instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
+            ..Default::default()
+        })
+    }
+}