Add hex-encoding examples based on base16ct (#595)

ascon-hash/Cargo.toml

@@ -23,6 +23,7 @@ ascon = { version = "0.4", default-features = false }
 spectral = { version = "0.6", default-features = false }
 hex = "0.4"
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["std"]

ascon-hash/README.md

@@ -28,6 +28,10 @@ hasher.update(b"some bytes");
 let hash = hasher.finalize();
 
 assert_eq!(hash, hex!("b742ca75e57038757059cccc6874714f9dbd7fc5924a7df4e316594fd1426ca8"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "b742ca75e57038757059cccc6874714f9dbd7fc5924a7df4e316594fd1426ca8");
 ```
 
 XOF hashing:

belt-hash/Cargo.toml

@@ -19,6 +19,7 @@ belt-block = { version = "0.1.1", default-features = false }
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["oid", "std"]

belt-hash/README.md

@@ -19,6 +19,10 @@ hasher.update(b"hello world");
 let hash = hasher.finalize();
 
 assert_eq!(hash, hex!("afb175816416fbadad4629ecbd78e1887789881f2d2e5b80c22a746b7ac7ba88"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "afb175816416fbadad4629ecbd78e1887789881f2d2e5b80c22a746b7ac7ba88");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

blake2/Cargo.toml

@@ -18,6 +18,7 @@ digest = { version = "=0.11.0-pre.8", features = ["mac"] }
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["std"]

blake2/README.md

@@ -24,17 +24,21 @@ let mut hasher = Blake2b512::new();
 hasher.update(b"hello world");
 
 // read hash digest and consume hasher
-let res = hasher.finalize();
-assert_eq!(res, hex!(
+let hash = hasher.finalize();
+assert_eq!(hash, hex!(
     "021ced8799296ceca557832ab941a50b4a11f83478cf141f51f933f653ab9fbc"
     "c05a037cddbed06e309bf334942c4e58cdf1a46e237911ccd7fcf9787cbc7fd0"
 ));
 
 // same example for Blake2s256:
 let mut hasher = Blake2s256::new();
 hasher.update(b"hello world");
-let res = hasher.finalize();
-assert_eq!(res, hex!("9aec6806794561107e594b1f6a8a6b0c92a0cba9acf5e5e93cca06f781813b0b"));
+let hash = hasher.finalize();
+assert_eq!(hash, hex!("9aec6806794561107e594b1f6a8a6b0c92a0cba9acf5e5e93cca06f781813b0b"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "9aec6806794561107e594b1f6a8a6b0c92a0cba9acf5e5e93cca06f781813b0b");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

fsb/Cargo.toml

@@ -19,6 +19,7 @@ whirlpool = { version = "=0.11.0-pre.2", path = "../whirlpool", default-features
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["std"]

fsb/README.md

@@ -31,6 +31,10 @@ hasher.update(b"hello");
 let hash = hasher.finalize();
 
 assert_eq!(hash, hex!("0f036dc3761aed2cba9de586a85976eedde6fa8f115c0190763decc02f28edbc"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "0f036dc3761aed2cba9de586a85976eedde6fa8f115c0190763decc02f28edbc");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

gost94/Cargo.toml

@@ -18,6 +18,7 @@ digest = "=0.11.0-pre.8"
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["oid", "std"]

gost94/README.md

@@ -20,6 +20,10 @@ hasher.update("The quick brown fox jumps over the lazy dog");
 let hash = hasher.finalize();
 
 assert_eq!(hash, hex!("9004294a361a508c586fe53d1f1b02746765e71b765472786e4770d565830a76"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "9004294a361a508c586fe53d1f1b02746765e71b765472786e4770d565830a76");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

groestl/Cargo.toml

@@ -18,6 +18,7 @@ digest = "=0.11.0-pre.8"
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["std"]

groestl/README.md

@@ -17,9 +17,13 @@ use hex_literal::hex;
 
 let mut hasher = Groestl256::default();
 hasher.update(b"my message");
-let result = hasher.finalize();
+let hash = hasher.finalize();
 
-assert_eq!(result, hex!("dc0283ca481efa76b7c19dd5a0b763dff0e867451bd9488a9c59f6c8b8047a86"));
+assert_eq!(hash, hex!("dc0283ca481efa76b7c19dd5a0b763dff0e867451bd9488a9c59f6c8b8047a86"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "dc0283ca481efa76b7c19dd5a0b763dff0e867451bd9488a9c59f6c8b8047a86");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

jh/Cargo.toml

@@ -19,6 +19,7 @@ simd = { package = "ppv-lite86", version = "0.2.6" }
 
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 zeroize = ["digest/zeroize"]

jh/README.md

@@ -24,9 +24,13 @@ use hex_literal::hex;
 
 let mut hasher = Jh256::new();
 hasher.update(b"hello");
-let result = hasher.finalize();
+let hash = hasher.finalize();
 
-assert_eq!(result, hex!("94fd3f4c564957c6754265676bf8b244c707d3ffb294e18af1f2e4f9b8306089"));
+assert_eq!(hash, hex!("94fd3f4c564957c6754265676bf8b244c707d3ffb294e18af1f2e4f9b8306089"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "94fd3f4c564957c6754265676bf8b244c707d3ffb294e18af1f2e4f9b8306089");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.

md2/Cargo.toml

@@ -18,6 +18,7 @@ digest = "=0.11.0-pre.8"
 [dev-dependencies]
 digest = { version = "=0.11.0-pre.8", features = ["dev"] }
 hex-literal = "0.4"
+base16ct = { version = "0.2", features = ["alloc"] }
 
 [features]
 default = ["oid", "std"]

md2/README.md

@@ -20,6 +20,10 @@ hasher.update(b"hello world");
 let hash = hasher.finalize();
 
 assert_eq!(hash, hex!("d9cce882ee690a5c1ce70beff3a78c77"));
+
+// Hex-encode hash using https://docs.rs/base16ct
+let hex_hash = base16ct::lower::encode_string(&hash);
+assert_eq!(hex_hash, "d9cce882ee690a5c1ce70beff3a78c77");
 ```
 
 Also, see the [examples section] in the RustCrypto/hashes readme.