make HOTP and TOTP return the OTPResult type (Will break tests)

Author: tmthecoder

src/hotp.rs

@@ -1,5 +1,6 @@
 // Implementation of the HOTP standard according to RFC4226 by Tejas Mehta
 
+use crate::otp_result::OTPResult;
 use crate::util::{base32_decode, get_code, hash_generic, MacDigest};
 
 /// A HOTP Generator
@@ -101,13 +102,14 @@ impl HOTP {
     ///
     /// # Panics
     /// This method panics if the hash's secret is incorrectly given.
-    pub fn get_otp(&self, counter: u64) -> u32 {
+    pub fn get_otp(&self, counter: u64) -> OTPResult {
         let hash = hash_generic(&counter.to_be_bytes(), &self.secret, &MacDigest::SHA1);
         let offset = (hash[hash.len() - 1] & 0xf) as usize;
         let bytes: [u8; 4] = hash[offset..offset + 4]
             .try_into()
             .expect("Failed byte get");
 
-        get_code(bytes, self.digits)
+        let code = get_code(bytes, self.digits);
+        OTPResult::new(self.digits, code)
     }
 }

src/otp_result.rs

@@ -1,6 +1,6 @@
 use std::time::{SystemTime, UNIX_EPOCH};
 
-struct OTPResult {
+pub struct OTPResult {
     digits: u32,
     code: u32,
 }

src/totp.rs

@@ -1,3 +1,4 @@
+use crate::otp_result::OTPResult;
 use crate::util::{base32_decode, get_code, hash_generic, MacDigest};
 
 /// A TOTP generator
@@ -158,7 +159,7 @@ impl TOTP {
     /// # Panics
     /// This method panics if the [`TOTP::get_otp_with_custom_time_start`]
     /// method does, which happens if the hash's secret is incorrectly given.
-    pub fn get_otp(&self, time: u64) -> u32 {
+    pub fn get_otp(&self, time: u64) -> OTPResult {
         self.get_otp_with_custom_time_start(time, 0)
     }
 
@@ -171,7 +172,7 @@ impl TOTP {
     ///
     /// # Panics
     /// This method panics if the hash's secret is incorrectly given.
-    pub fn get_otp_with_custom_time_start(&self, time: u64, time_start: u64) -> u32 {
+    pub fn get_otp_with_custom_time_start(&self, time: u64, time_start: u64) -> OTPResult {
         let time_count = (time - time_start) / self.period;
 
         let hash = hash_generic(&time_count.to_be_bytes(), &self.secret, &self.mac_digest);
@@ -180,6 +181,8 @@ impl TOTP {
             .try_into()
             .expect("Failed byte get");
 
-        get_code(bytes, self.digits)
+
+        let code = get_code(bytes, self.digits);
+        OTPResult::new(self.digits, code)
     }
 }