From 88c7b69d743cbae590bf7348138f76c46e59a777 Mon Sep 17 00:00:00 2001
From: Samuel Onoja <samiodev@icloud.com>
Date: Sat, 2 Nov 2024 08:12:42 +0100
Subject: [PATCH] impl is_zeroes feature

---
 src/lib.rs    | 34 ++++++++++++++++++++++++++++++++++
 tests/test.rs | 19 +++++++++++++++++++
 2 files changed, 53 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index ef01dfa..6101341 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -627,6 +627,40 @@ unsafe fn decode_checked(input: &[u8], output: &mut [u8]) -> Result<(), FromHexE
     Err(unsafe { invalid_hex_error(input) })
 }
 
+/// Checks if a hex string contains only zeros ('0' characters).
+///
+/// Both uppercase and lowercase hex strings are supported, and can be mixed.
+/// The '0x' prefix is automatically stripped if present.
+///
+/// Returns true only if the entire string (after removing any '0x' prefix)
+/// consists of '0' characters. Returns false if any non-zero hex digit is found.
+///
+/// # Example
+///
+/// ```
+/// assert!(const_hex::is_zeroes("000000"));
+/// assert!(const_hex::is_zeroes("0x000000"));
+///
+/// assert!(!const_hex::is_zeroes("100000"));
+/// assert!(!const_hex::is_zeroes("0x100000"));
+/// assert!(!const_hex::is_zeroes("000100"));
+/// assert!(!const_hex::is_zeroes(""));
+/// ```
+#[cfg(feature = "alloc")]
+#[inline]
+pub fn is_zeroes(hex: &str) -> bool {
+    if hex.is_empty() {
+        return false;
+    }
+    let bytes = strip_prefix(hex.as_bytes());
+    for &b in bytes {
+        if b != b'0' {
+            return false;
+        }
+    }
+    true
+}
+
 #[inline]
 const fn byte2hex<const UPPER: bool>(byte: u8) -> (u8, u8) {
     let table = get_chars_table::<UPPER>();
diff --git a/tests/test.rs b/tests/test.rs
index e1b0116..889008b 100644
--- a/tests/test.rs
+++ b/tests/test.rs
@@ -214,3 +214,22 @@ fn assert_upper(s: &str) {
     assert_eq!(ALL_UPPER, expected);
     assert_eq!(s, expected);
 }
+
+#[cfg(feature = "alloc")]
+#[test]
+fn test_is_zeroes() {
+    // Test with standard zero-only strings
+    assert!(const_hex::is_zeroes("00000000"));
+    assert!(const_hex::is_zeroes("0x00000000"));
+    assert!(const_hex::is_zeroes("00000000000000000000000000000000"));
+    assert!(const_hex::is_zeroes("0x00000000000000000000000000000000"));
+
+    // Test with non-zero hex strings
+    assert!(!const_hex::is_zeroes("00000001"));
+    assert!(!const_hex::is_zeroes("0x00000001"));
+    assert!(!const_hex::is_zeroes("1234567890abcdef"));
+    assert!(!const_hex::is_zeroes("0x1234567890abcdef"));
+
+    // Test with empty string (could be considered as not zeroes)
+    assert!(!const_hex::is_zeroes(""));
+}