Define a type for blob IDs.

Author: artob

lib/asimov-kb/src/blob_id.rs

@@ -0,0 +1,76 @@
+// This is free and unencumbered software released into the public domain.
+
+use crate::{Id, IdClass, IdError};
+use core::{str::FromStr, ops::RangeInclusive};
+use derive_more::Display;
+
+#[derive(Clone, Debug, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
+pub struct BlobId(pub(crate) Id<32>);
+
+impl BlobId {
+    pub const ID_LEN_MIN: usize = 1 + 16; // TODO
+    pub const ID_LEN_MAX: usize = 1 + 22; // TODO
+    pub const ID_LEN: RangeInclusive<usize> = Self::ID_LEN_MIN..=Self::ID_LEN_MAX;
+
+    pub fn as_id(&self) -> &Id<32> {
+        &self.0
+    }
+
+    pub fn into_id(self) -> Id<32> {
+        self.0
+    }
+}
+
+impl From<[u8; 32]> for BlobId {
+    fn from(bytes: [u8; 32]) -> Self {
+        Self(Id::from((IdClass::Blob, bytes)))
+    }
+}
+
+impl From<&Vec<u8>> for BlobId {
+    fn from(bytes: &Vec<u8>) -> Self {
+        Self(Id::from((IdClass::Blob, bytes)))
+    }
+}
+
+impl FromStr for BlobId {
+    type Err = IdError;
+
+    fn from_str(input: &str) -> Result<Self, Self::Err> {
+        let id = Id::from_str(input)?;
+        if id.class() != IdClass::Blob {
+            return Err(IdError::UnknownClass);
+        }
+        Ok(Self(id))
+    }
+}
+
+#[cfg(feature = "eloquent")]
+impl eloquent::ToSql for BlobId {
+    fn to_sql(&self) -> Result<String, eloquent::error::EloquentError> {
+        self.as_id().to_sql()
+    }
+}
+
+#[cfg(feature = "libsql")]
+impl libsql::params::IntoValue for BlobId {
+    fn into_value(self) -> libsql::Result<libsql::Value> {
+        self.into_id().into_value()
+    }
+}
+
+#[cfg(feature = "rocket")]
+impl<'r> rocket::request::FromParam<'r> for BlobId {
+    type Error = IdError;
+
+    fn from_param(input: &'r str) -> Result<Self, Self::Error> {
+        Self::from_str(input)
+    }
+}
+
+#[cfg(feature = "turso")]
+impl turso::IntoValue for BlobId {
+    fn into_value(self) -> turso::Result<turso::Value> {
+        self.into_id().into_value()
+    }
+}

lib/asimov-kb/src/event_id.rs

@@ -1,15 +1,19 @@
 // This is free and unencumbered software released into the public domain.
 
 use crate::{Id, IdClass, IdError};
-use core::str::FromStr;
+use core::{str::FromStr, ops::RangeInclusive};
 use derive_more::Display;
 
 #[derive(Clone, Debug, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
-pub struct EventId(pub(crate) Id);
+pub struct EventId(pub(crate) Id<16>);
 
 impl EventId {
+    pub const ID_LEN_MIN: usize = 1 + 16;
+    pub const ID_LEN_MAX: usize = 1 + 22;
+    pub const ID_LEN: RangeInclusive<usize> = Self::ID_LEN_MIN..=Self::ID_LEN_MAX;
+
     pub fn new() -> Self {
-        Self(Id::new(IdClass::Event))
+        Self(Id::new_uuid(IdClass::Event))
     }
 
     pub fn as_id(&self) -> &Id {

lib/asimov-kb/src/id.rs

@@ -1,32 +1,21 @@
 // This is free and unencumbered software released into the public domain.
 
 use crate::{IdClass, IdError};
-use core::{ops::RangeInclusive, str::FromStr};
+use core::{str::FromStr};
 use derive_more::Display;
 
-pub const ID_LENGTH_MIN: usize = 1 + 16;
-pub const ID_LENGTH_MAX: usize = 1 + 22;
-pub const ID_LENGTH: RangeInclusive<usize> = ID_LENGTH_MIN..=ID_LENGTH_MAX;
-
 #[derive(Clone, Debug, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
 #[display("{class}{}", bs58::encode(bytes).into_string())]
-pub struct Id {
+pub struct Id<const N: usize = 16> {
     pub(crate) class: IdClass,
-    pub(crate) bytes: [u8; 16],
+    pub(crate) bytes: [u8; N],
 }
 
-impl Id {
+impl<const N: usize> Id<N> {
     pub fn zero(class: IdClass) -> Self {
         Self {
             class,
-            bytes: [0u8; 16],
-        }
-    }
-
-    pub fn new(class: IdClass) -> Self {
-        Self {
-            class,
-            bytes: uuid::Uuid::now_v7().into_bytes(),
+            bytes: [0u8; N],
         }
     }
 
@@ -38,18 +27,10 @@ impl Id {
         self.bytes.as_slice()
     }
 
-    pub fn as_uuid(&self) -> uuid::Uuid {
-        uuid::Uuid::from_bytes(self.bytes)
-    }
-
-    pub fn into_bytes(self) -> [u8; 16] {
+    pub fn into_bytes(self) -> [u8; N] {
         self.bytes
     }
 
-    pub fn into_uuid(self) -> uuid::Uuid {
-        uuid::Uuid::from_bytes(self.bytes)
-    }
-
     #[cfg(feature = "std")]
     pub fn yaml_path(&self) -> std::path::PathBuf {
         self.dir_path().join(self.class().yaml_path())
@@ -73,21 +54,39 @@ impl Id {
     }
 }
 
-impl From<(IdClass, [u8; 16])> for Id {
-    fn from((class, bytes): (IdClass, [u8; 16])) -> Self {
+impl Id<16> {
+    pub fn new_uuid(class: IdClass) -> Self {
+        Self {
+            class,
+            bytes: uuid::Uuid::now_v7().into_bytes(),
+        }
+    }
+
+    pub fn as_uuid(&self) -> uuid::Uuid {
+        uuid::Uuid::from_bytes(self.bytes)
+    }
+
+    pub fn into_uuid(self) -> uuid::Uuid {
+        uuid::Uuid::from_bytes(self.bytes)
+    }
+}
+
+impl<const N: usize> From<(IdClass, [u8; N])> for Id<N> {
+    fn from((class, bytes): (IdClass, [u8; N])) -> Self {
         Self { class, bytes }
     }
 }
 
-impl From<(IdClass, &Vec<u8>)> for Id {
+impl<const N: usize> From<(IdClass, &Vec<u8>)> for Id<N> {
     fn from((class, bytes_vec): (IdClass, &Vec<u8>)) -> Self {
-        let mut bytes = [0u8; 16];
-        bytes[0..].copy_from_slice(&bytes_vec[0..16]);
+        let mut bytes = [0u8; N];
+        let len = N.min(bytes_vec.len());
+        bytes[..len].copy_from_slice(&bytes_vec[..len]);
         Self { class, bytes }
     }
 }
 
-impl FromStr for Id {
+impl<const N: usize> FromStr for Id<N> {
     type Err = IdError;
 
     fn from_str(input: &str) -> Result<Self, Self::Err> {
@@ -112,22 +111,22 @@ impl FromStr for Id {
 }
 
 #[cfg(feature = "eloquent")]
-impl eloquent::ToSql for Id {
+impl<const N: usize> eloquent::ToSql for Id<N> {
     fn to_sql(&self) -> Result<String, eloquent::error::EloquentError> {
         let hex: String = self.bytes.iter().map(|b| format!("{b:02X}")).collect();
         Ok(format!("X'{hex}'"))
     }
 }
 
 #[cfg(feature = "libsql")]
-impl libsql::params::IntoValue for Id {
+impl<const N: usize> libsql::params::IntoValue for Id<N> {
     fn into_value(self) -> libsql::Result<libsql::Value> {
         Ok(libsql::Value::Blob(self.bytes.to_vec()))
     }
 }
 
 #[cfg(feature = "rocket")]
-impl<'r> rocket::request::FromParam<'r> for Id {
+impl<'r, const N: usize> rocket::request::FromParam<'r> for Id<N> {
     type Error = IdError;
 
     fn from_param(input: &'r str) -> Result<Self, Self::Error> {
@@ -136,7 +135,7 @@ impl<'r> rocket::request::FromParam<'r> for Id {
 }
 
 #[cfg(feature = "turso")]
-impl turso::IntoValue for Id {
+impl<const N: usize> turso::IntoValue for Id<N> {
     fn into_value(self) -> turso::Result<turso::Value> {
         Ok(turso::Value::Blob(self.bytes.to_vec()))
     }

lib/asimov-kb/src/id_class.rs

@@ -7,6 +7,8 @@ use derive_more::Display;
 #[derive(Clone, Copy, Debug, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
 pub enum IdClass {
+    #[display("B")]
+    Blob,
     #[display("E")]
     Event,
     #[display("P")]
@@ -17,6 +19,7 @@ impl IdClass {
     #[cfg(feature = "std")]
     pub fn yaml_path(&self) -> std::path::PathBuf {
         match self {
+            Self::Blob => "blob.yaml",
             Self::Event => "event.yaml",
             Self::Person => "person.yaml",
         }
@@ -26,6 +29,7 @@ impl IdClass {
     #[cfg(feature = "std")]
     pub fn dir_path(&self) -> std::path::PathBuf {
         match self {
+            Self::Blob => "blobs",
             Self::Event => "events",
             Self::Person => "people",
         }
@@ -38,6 +42,7 @@ impl FromStr for IdClass {
 
     fn from_str(input: &str) -> Result<Self, Self::Err> {
         Ok(match input.chars().next().unwrap_or_default() {
+            'B' => Self::Blob,
             'E' => Self::Event,
             'P' => Self::Person,
             _ => return Err(IdError::UnknownClass),

lib/asimov-kb/src/lib.rs

@@ -1,5 +1,8 @@
 // This is free and unencumbered software released into the public domain.
 
+mod blob_id;
+pub use blob_id::*;
+
 mod event_id;
 pub use event_id::*;
 

lib/asimov-kb/src/person_id.rs

@@ -1,15 +1,19 @@
 // This is free and unencumbered software released into the public domain.
 
 use crate::{Id, IdClass, IdError};
-use core::str::FromStr;
+use core::{str::FromStr, ops::RangeInclusive};
 use derive_more::Display;
 
 #[derive(Clone, Debug, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
-pub struct PersonId(pub(crate) Id);
+pub struct PersonId(pub(crate) Id<16>);
 
 impl PersonId {
+    pub const ID_LEN_MIN: usize = 1 + 16;
+    pub const ID_LEN_MAX: usize = 1 + 22;
+    pub const ID_LEN: RangeInclusive<usize> = Self::ID_LEN_MIN..=Self::ID_LEN_MAX;
+
     pub fn new() -> Self {
-        Self(Id::new(IdClass::Person))
+        Self(Id::new_uuid(IdClass::Person))
     }
 
     pub fn as_id(&self) -> &Id {