feat: v1.0.0

Author: eastspire

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "china_identification_card"
-version = "0.3.4"
+version = "1.0.0"
 edition = "2024"
 license = "MIT"
 description = "A Rust library for validating Chinese identification card numbers based on official rules and checksums."

readme.md

@@ -32,7 +32,11 @@ cargo add china_identification_card
 
 ```rust
 use china_identification_card::*;
-let is_valid: bool = is_valid_id_number("110101202311012176");
+
+let valid: bool = ChineseIdCard::is_valid_id_number("110101202311012176");
+assert_eq!(valid, true);
+let un_valid: bool = ChineseIdCard::is_invalid_id_number("110101202311012171");
+assert_eq!(un_valid, true);
 ```
 
 ## License

src/cfg.rs

@@ -1,8 +1,9 @@
-use crate::*;
 #[test]
 fn test_is_valid_id_number() {
-    let valid: bool = is_valid_id_number("110101202311012176");
+    use crate::*;
+
+    let valid: bool = ChineseIdCard::is_valid_id_number("110101202311012176");
     assert_eq!(valid, true);
-    let unvalid: bool = is_valid_id_number("110101202311012171");
-    assert_eq!(unvalid, false);
+    let un_valid: bool = ChineseIdCard::is_invalid_id_number("110101202311012171");
+    assert_eq!(un_valid, true);
 }

src/chinese_id_card/const.rs

@@ -0,0 +1,2 @@
+pub(crate) const WEIGHTS: [i32; 17] = [7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2];
+pub(crate) const CHECK_CODES: [char; 11] = ['1', '0', 'X', '9', '8', '7', '6', '5', '4', '3', '2'];

src/chinese_id_card/impl.rs

@@ -0,0 +1,25 @@
+use crate::*;
+
+impl ChineseIdCard {
+    pub fn is_valid_id_number<T: ToString>(id_number: T) -> bool {
+        let id_number_string: String = id_number.to_string();
+        if id_number_string.len() != 18 || !id_number_string[..17].chars().all(|c| c.is_digit(10)) {
+            return false;
+        }
+        let last_char: char = id_number_string.chars().last().unwrap();
+        if !(last_char.is_digit(10) || last_char == 'X') {
+            return false;
+        }
+        let sum: i32 = id_number_string[..17]
+            .chars()
+            .zip(WEIGHTS.iter())
+            .map(|(c, &w)| c.to_digit(10).unwrap() as i32 * w)
+            .sum();
+        let check_code: char = CHECK_CODES[(sum % 11) as usize];
+        check_code == last_char
+    }
+
+    pub fn is_invalid_id_number<T: ToString>(id_number: T) -> bool {
+        Self::is_valid_id_number(id_number)
+    }
+}

src/chinese_id_card/mod.rs

@@ -0,0 +1,6 @@
+pub(crate) mod r#const;
+pub(crate) mod r#impl;
+pub(crate) mod r#struct;
+
+pub(crate) use r#const::*;
+pub use r#struct::*;

src/chinese_id_card/struct.rs

@@ -0,0 +1 @@
+pub struct ChineseIdCard;

src/lib.rs

@@ -1,38 +1,5 @@
-#![allow(warnings)]
-
 mod cfg;
 
-/// Checks if the given Chinese ID number is valid.
-///
-/// # Arguments
-/// - `id_number`: The ID number to validate.
-///
-/// # Returns
-/// A boolean value indicating validity. Returns `true` if valid, `false` otherwise.
-///
-/// # Examples
-/// ```
-/// use china_identification_card::*;
-/// let is_valid: bool = is_valid_id_number("110101202311012176");
-/// ```
-pub fn is_valid_id_number(id_number: &str) -> bool {
-    // Ensure the length is 18, first 17 characters are digits, and the 18th is a digit or 'X'
-    if id_number.len() != 18 || !id_number[..17].chars().all(|c| c.is_digit(10)) {
-        return false;
-    }
-    let last_char: char = id_number.chars().last().unwrap();
-    if !(last_char.is_digit(10) || last_char == 'X') {
-        return false;
-    }
-    // Weight factors and checksum table
-    const WEIGHTS: [i32; 17] = [7, 9, 10, 5, 8, 4, 2, 1, 6, 3, 7, 9, 10, 5, 8, 4, 2];
-    const CHECK_CODES: [char; 11] = ['1', '0', 'X', '9', '8', '7', '6', '5', '4', '3', '2'];
-    // Calculate the checksum
-    let sum: i32 = id_number[..17]
-        .chars()
-        .zip(WEIGHTS.iter())
-        .map(|(c, &w)| c.to_digit(10).unwrap() as i32 * w)
-        .sum();
-    let check_code: char = CHECK_CODES[(sum % 11) as usize];
-    check_code == last_char
-}
+pub(crate) mod chinese_id_card;
+
+pub use chinese_id_card::*;