Merge branch 'faster-hex'

Author: Byron

Cargo.lock

@@ -19,7 +19,7 @@ serde= ["dep:serde"]
 
 [dependencies]
 thiserror = "1.0.33"
-hex = "0.4.2"
+faster-hex = "0.8.0"
 serde = { version = "1.0.114", optional = true, default-features = false, features = ["derive"] }
 
 document-features = { version = "0.2.0", optional = true }

gix-hash/Cargo.toml

@@ -40,8 +40,8 @@ pub mod decode {
     pub enum Error {
         #[error("A hash sized {0} hexadecimal characters is invalid")]
         InvalidHexEncodingLength(usize),
-        #[error("Invalid character {c} at position {index}")]
-        Invalid { c: char, index: usize },
+        #[error("Invalid character encountered")]
+        Invalid,
     }
 
     /// Hash decoding
@@ -50,16 +50,19 @@ pub mod decode {
         ///
         /// Such a buffer can be obtained using [`oid::write_hex_to(buffer)`][super::oid::write_hex_to()]
         pub fn from_hex(buffer: &[u8]) -> Result<ObjectId, Error> {
-            use hex::FromHex;
             match buffer.len() {
-                40 => Ok(ObjectId::Sha1(<[u8; 20]>::from_hex(buffer).map_err(
-                    |err| match err {
-                        hex::FromHexError::InvalidHexCharacter { c, index } => Error::Invalid { c, index },
-                        hex::FromHexError::OddLength | hex::FromHexError::InvalidStringLength => {
-                            unreachable!("BUG: This is already checked")
-                        }
-                    },
-                )?)),
+                40 => Ok({
+                    ObjectId::Sha1({
+                        let mut buf = [0; 20];
+                        faster_hex::hex_decode(buffer, &mut buf).map_err(|err| match err {
+                            faster_hex::Error::InvalidChar => Error::Invalid,
+                            faster_hex::Error::InvalidLength(_) => {
+                                unreachable!("BUG: This is already checked")
+                            }
+                        })?;
+                        buf
+                    })
+                }),
                 len => Err(Error::InvalidHexEncodingLength(len)),
             }
         }

gix-hash/src/object_id.rs

@@ -148,7 +148,7 @@ impl oid {
     #[must_use]
     pub fn hex_to_buf(&self, buf: &mut [u8]) -> usize {
         let num_hex_bytes = self.bytes.len() * 2;
-        hex::encode_to_slice(&self.bytes, &mut buf[..num_hex_bytes]).expect("to count correctly");
+        faster_hex::hex_encode(&self.bytes, &mut buf[..num_hex_bytes]).expect("to count correctly");
         num_hex_bytes
     }
 

gix-hash/src/oid.rs

@@ -28,8 +28,8 @@ pub mod from_hex {
         TooShort { hex_len: usize },
         #[error("An id cannot be larger than {} chars in hex, but {hex_len} was requested", crate::Kind::longest().len_in_hex())]
         TooLong { hex_len: usize },
-        #[error("Invalid character {c} at position {index}")]
-        Invalid { c: char, index: usize },
+        #[error("Invalid hex character")]
+        Invalid,
     }
 }
 
@@ -95,7 +95,6 @@ impl Prefix {
 
     /// Create an instance from the given hexadecimal prefix `value`, e.g. `35e77c16` would yield a `Prefix` with `hex_len()` = 8.
     pub fn from_hex(value: &str) -> Result<Self, from_hex::Error> {
-        use hex::FromHex;
         let hex_len = value.len();
 
         if hex_len > crate::Kind::longest().len_in_hex() {
@@ -105,16 +104,20 @@ impl Prefix {
         };
 
         let src = if value.len() % 2 == 0 {
-            Vec::from_hex(value)
+            let mut out = Vec::from_iter(std::iter::repeat(0).take(value.len() / 2));
+            faster_hex::hex_decode(value.as_bytes(), &mut out).map(move |_| out)
         } else {
+            // TODO(perf): do without heap allocation here.
             let mut buf = [0u8; crate::Kind::longest().len_in_hex()];
             buf[..value.len()].copy_from_slice(value.as_bytes());
             buf[value.len()] = b'0';
-            Vec::from_hex(&buf[..=value.len()])
+            let src = &buf[..=value.len()];
+            let mut out = Vec::from_iter(std::iter::repeat(0).take(src.len() / 2));
+            faster_hex::hex_decode(src, &mut out).map(move |_| out)
         }
         .map_err(|e| match e {
-            hex::FromHexError::InvalidHexCharacter { c, index } => from_hex::Error::Invalid { c, index },
-            hex::FromHexError::OddLength | hex::FromHexError::InvalidStringLength => panic!("This is already checked"),
+            faster_hex::Error::InvalidChar => from_hex::Error::Invalid,
+            faster_hex::Error::InvalidLength(_) => panic!("This is already checked"),
         })?;
 
         let mut bytes = ObjectId::null(crate::Kind::from_hex_len(value.len()).expect("hex-len is already checked"));

gix-hash/src/prefix.rs

@@ -21,7 +21,7 @@ mod from_hex {
         fn non_hex_characters() {
             assert!(matches!(
                 ObjectId::from_hex(b"zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz").unwrap_err(),
-                decode::Error::Invalid { index: 0, c: 'z' }
+                decode::Error::Invalid
             ));
         }
 

gix-hash/tests/object_id/mod.rs

@@ -117,7 +117,7 @@ mod try_from {
     #[test]
     fn invalid_chars() {
         let input = "abcdfOsd";
-        let expected = Error::Invalid { c: 'O', index: 5 };
+        let expected = Error::Invalid;
         let actual = Prefix::try_from(input).unwrap_err();
         assert_eq!(actual, expected);
     }

gix-hash/tests/prefix/mod.rs

@@ -31,7 +31,6 @@ gix-date = { version = "^0.7.2", path = "../gix-date" }
 btoi = "0.4.2"
 itoa = "1.0.1"
 thiserror = "1.0.34"
-hex = "0.4.2"
 bstr = { version = "1.3.0", default-features = false, features = ["std", "unicode"] }
 nom = { version = "7", default-features = false, features = ["std"]}
 smallvec = { version = "1.4.0", features = ["write"] }

gix-object/Cargo.toml

@@ -26,7 +26,7 @@ serde = ["dep:serde", "bstr/serde"]
 [dependencies]
 serde = { version = "1.0.114", optional = true, default-features = false, features = ["std", "derive"]}
 thiserror = "1.0.34"
-hex = "0.4.2"
+faster-hex = "0.8.0"
 bstr = { version = "1.3.0", default-features = false, features = ["std"] }
 
 document-features = { version = "0.2.0", optional = true }

gix-packetline-blocking/Cargo.toml

@@ -41,7 +41,7 @@ required-features = ["blocking-io", "maybe-async/is_sync"]
 [dependencies]
 serde = { version = "1.0.114", optional = true, default-features = false, features = ["std", "derive"]}
 thiserror = "1.0.34"
-hex = "0.4.2"
+faster-hex = "0.8.0"
 bstr = { version = "1.3.0", default-features = false, features = ["std"] }
 # async support
 futures-io = { version = "0.3.16", optional = true }