export PH

src/lib.rs

@@ -99,6 +99,7 @@ mod types;
 
 /// All functionality is covered by traits, such that consumers can utilize trait objects as desired.
 pub mod traits;
+pub use crate::types::Ph;
 
 // Applies across all security parameter sets
 const Q: i32 = 8_380_417; // 2^23 - 2^13 + 1 = 0x7FE001; See https://oeis.org/A234388

src/types.rs

@@ -1,12 +1,17 @@
 use zeroize::{Zeroize, ZeroizeOnDrop};
 
+
 /// Supported hash functions for `hash_sign()` and `hash_verify()` functions
 pub enum Ph {
+    /// Use SHA256 as the pre-hash function
     SHA256,
+    /// Use SHA512 as the pre-hash function
     SHA512,
+    /// Use Shake128 as the pre-hash function
     SHAKE128,
 }
 
+
 /// Correctly sized private key specific to the target security parameter set. <br>
 /// Implements the [`crate::traits::Signer`] and [`crate::traits::SerDes`] trait.
 #[derive(Clone, Zeroize, ZeroizeOnDrop)]