Updates

Author: alpheusmtx

Cargo.lock

@@ -26,7 +26,7 @@ Or start a customization with the following code:
 use rowid::{RowIDWithConfig, RowIDWithConfigResult};
 
 let rwc: RowIDWithConfigResult = RowIDWithConfig::new()
-    .char_list("0123456789ABCDEFGHJKMNPQRSTVWXYZ".to_string())
+    .char_list("0123456789ABCDEFGHJKMNPQRSTVWXYZ")
     .randomness_length(22)
     .done()
     .unwrap();

README.md

@@ -8,10 +8,7 @@ mod tests {
         GenerateResult, RowIDWithConfig, RowIDWithConfigResult, VerifyResult,
     };
 
-    use rowid::errors::{
-        DECODE_ECD_INVALID_ERR, DECODE_ECD_LENGTH_ERR,
-        RWC_DONE_CHAR_LIST_LENGTH_ERR,
-    };
+    use rowid::RowIDError;
 
     // system_time_to_timestamp
 
@@ -92,7 +89,7 @@ mod tests {
     #[test]
     fn test_decode() {
         let current: SystemTime = SystemTime::now();
-        let decoded: SystemTime = decode(encode(current).unwrap()).unwrap();
+        let decoded: SystemTime = decode(&encode(current).unwrap()).unwrap();
         assert!(
             system_time_to_timestamp(decoded)
                 == system_time_to_timestamp(current)
@@ -101,24 +98,24 @@ mod tests {
 
     #[test]
     fn test_decode_length_error() {
-        let result: io::Error = match decode("ABC123".to_string()) {
+        let result: io::Error = match decode("ABC123") {
             | Ok(_) => return assert!(false),
             | Err(e) => e,
         };
 
         assert!(result.kind() == io::ErrorKind::InvalidInput);
-        assert!(result.to_string() == DECODE_ECD_LENGTH_ERR);
+        assert!(result.to_string() == RowIDError::EncodedLength.as_str());
     }
 
     #[test]
     fn test_decode_invalid_input_error() {
-        let result: io::Error = match decode("ab^!@#$agastgyaSER".to_string()) {
+        let result: io::Error = match decode("ab^!@#$agastgyaSER") {
             | Ok(_) => return assert!(false),
             | Err(e) => e,
         };
 
         assert!(result.kind() == io::ErrorKind::InvalidInput);
-        assert!(result.to_string() == DECODE_ECD_INVALID_ERR);
+        assert!(result.to_string() == RowIDError::InvalidEncoded.as_str());
     }
 
     // generate
@@ -130,7 +127,7 @@ mod tests {
         let id: String = generated.result.unwrap();
         assert!(generated.success == true);
         assert!(
-            system_time_to_timestamp(decode(id.clone()).unwrap())
+            system_time_to_timestamp(decode(&id).unwrap())
                 == system_time_to_timestamp(current)
         );
         assert!(id.len() == 16);
@@ -142,7 +139,7 @@ mod tests {
     fn test_verify() {
         let current: SystemTime = SystemTime::now();
         let id: String = generate(current, Some(6)).result.unwrap();
-        let verified: VerifyResult = verify(id);
+        let verified: VerifyResult = verify(&id);
         assert!(verified.success == true);
         assert!(match verified.result {
             | Some(r) =>
@@ -154,7 +151,7 @@ mod tests {
 
     #[test]
     fn test_verify_length_error() {
-        let verified: VerifyResult = verify("ABC123".to_string());
+        let verified: VerifyResult = verify("ABC123");
 
         assert!(verified.success == false);
 
@@ -164,12 +161,12 @@ mod tests {
         };
 
         assert!(error.kind() == io::ErrorKind::InvalidInput);
-        assert!(error.to_string() == DECODE_ECD_LENGTH_ERR);
+        assert!(error.to_string() == RowIDError::EncodedLength.as_str());
     }
 
     #[test]
     fn test_verify_invalid_input_error() {
-        let verified: VerifyResult = verify("ab^!@#$agastgyaSER".to_string());
+        let verified: VerifyResult = verify("ab^!@#$agastgyaSER");
 
         assert!(verified.success == false);
 
@@ -179,21 +176,21 @@ mod tests {
         };
 
         assert!(error.kind() == io::ErrorKind::InvalidInput);
-        assert!(error.to_string() == DECODE_ECD_INVALID_ERR);
+        assert!(error.to_string() == RowIDError::InvalidEncoded.as_str());
     }
 
     // rowid_with_config
 
     #[test]
     fn test_rowid_with_config_char_list_length_error() {
         let err: io::Error =
-            match RowIDWithConfig::new().char_list("ABC".to_string()).done() {
+            match RowIDWithConfig::new().char_list("ABC").done() {
                 | Ok(_) => return assert!(false),
                 | Err(e) => e,
             };
 
         assert!(err.kind() == io::ErrorKind::InvalidInput);
-        assert!(err.to_string() == RWC_DONE_CHAR_LIST_LENGTH_ERR);
+        assert!(err.to_string() == RowIDError::CharListLength.as_str());
     }
 
     #[test]
@@ -223,7 +220,7 @@ mod tests {
 
         let current: SystemTime = SystemTime::now();
         let decoded: SystemTime =
-            rwc.decode(rwc.encode(current).unwrap()).unwrap();
+            rwc.decode(&rwc.encode(current).unwrap()).unwrap();
 
         assert!(
             system_time_to_timestamp(decoded)
@@ -241,9 +238,9 @@ mod tests {
         let id: String = generated.result.unwrap();
 
         assert!(generated.success == true);
-        assert!(id.clone().len() == 16);
+        assert!(id.len() == 16);
         assert!(
-            system_time_to_timestamp(rwc.decode(id.clone()).unwrap())
+            system_time_to_timestamp(rwc.decode(&id).unwrap())
                 == system_time_to_timestamp(current)
         );
     }
@@ -255,7 +252,7 @@ mod tests {
 
         let current: SystemTime = SystemTime::now();
         let generated: GenerateResult = rwc.generate(current, None);
-        let verified: VerifyResult = rwc.verify(generated.result.unwrap());
+        let verified: VerifyResult = rwc.verify(&generated.result.unwrap());
 
         assert!(verified.success == true);
         assert!(match verified.result {

__test__/src/lib.rs

@@ -1,3 +1,23 @@
+## 0.2.0 (2024-10-13)
+
+### Breaking Changes
+
+- Changes in accepted value type of `decode`:
+    - `String` => `&str`
+- Changes in accepted value type of `verify`:
+    - `String` => `&str`
+- Changes in accepted value type of `char_list` in `RowIDWithConfig`:
+    - `String` => `&str`
+- Merge different error messages into `RowIDError` enum
+
+### What's New
+
+- Add different derives for different structs
+
+### What's Changed
+
+- Updates in documentation
+
 ## 0.1.1 (2024-08-04)
 
 ### What's Changed

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "rowid"
-version = "0.1.1"
+version = "0.2.0"
 authors = ["Alpheus Tang"]
 edition = "2021"
 description = """
@@ -32,4 +32,4 @@ name = "rowid"
 path = "src/lib.rs"
 
 [dependencies]
-rand = "0.8.5"
+rand = "~0.8.5"

package/Cargo.toml

@@ -18,7 +18,7 @@ Or start a customization with the following code:
 use rowid::{RowIDWithConfig, RowIDWithConfigResult};
 
 let rwc: RowIDWithConfigResult = RowIDWithConfig::new()
-    .char_list("0123456789ABCDEFGHJKMNPQRSTVWXYZ".to_string())
+    .char_list("0123456789ABCDEFGHJKMNPQRSTVWXYZ")
     .randomness_length(22)
     .done()
     .unwrap();

package/README.md

@@ -27,7 +27,7 @@ use crate::functions::verify::{
 /// ```
 pub fn rowid() -> String {
     _rowid(RowIDOptions {
-        char_list: CHAR_LIST.to_string(),
+        char_list: CHAR_LIST,
         randomness_length: RANDOMNESS_LENGTH,
     })
 }
@@ -44,7 +44,7 @@ pub fn rowid() -> String {
 /// let encoded: String = encode(SystemTime::now()).unwrap();
 /// ```
 pub fn encode(system_time: SystemTime) -> io::Result<String> {
-    _encode(EncodeOptions { char_list: CHAR_LIST.to_string(), system_time })
+    _encode(EncodeOptions { char_list: CHAR_LIST, system_time })
 }
 
 /// This function decodes the ID into a timestamp in milliseconds.
@@ -55,10 +55,10 @@ pub fn encode(system_time: SystemTime) -> io::Result<String> {
 /// use std::time::SystemTime;
 /// use rowid::decode;
 ///
-/// let decoded: SystemTime = decode("ABC123".to_string()).unwrap();
+/// let decoded: SystemTime = decode("ABC123").unwrap();
 /// ```
-pub fn decode(encoded: String) -> io::Result<SystemTime> {
-    _decode(DecodeOptions { char_list: CHAR_LIST.to_string(), encoded })
+pub fn decode(encoded: &str) -> io::Result<SystemTime> {
+    _decode(DecodeOptions { char_list: CHAR_LIST, encoded })
 }
 
 /// This function generates an ID based on the input.
@@ -77,7 +77,7 @@ pub fn generate(
     randomness_length: Option<usize>,
 ) -> GenerateResult {
     _generate(GenerateOptions {
-        char_list: CHAR_LIST.to_string(),
+        char_list: CHAR_LIST,
         system_time,
         randomness_length: match randomness_length {
             | Some(l) => l,
@@ -93,10 +93,10 @@ pub fn generate(
 /// ```no_run
 /// use rowid::{verify, VerifyResult};
 ///
-/// let result: VerifyResult = verify("ABC123".to_string());
+/// let result: VerifyResult = verify("ABC123");
 /// ```
-pub fn verify(encoded: String) -> VerifyResult {
-    _verify(VerifyOptions { char_list: CHAR_LIST.to_string(), encoded })
+pub fn verify(encoded: &str) -> VerifyResult {
+    _verify(VerifyOptions { char_list: CHAR_LIST, encoded })
 }
 
 /// This function generates randomness.
@@ -110,7 +110,7 @@ pub fn verify(encoded: String) -> VerifyResult {
 /// ```
 pub fn get_randomness(randomness_length: usize) -> String {
     _get_randomness(GetRandomnessOptions {
-        char_list: CHAR_LIST.to_string(),
+        char_list: CHAR_LIST,
         randomness_length,
     })
 }