Changing the name of some methods

Author: orion78fr

src/hotp.rs

@@ -43,7 +43,7 @@ impl HOTP {
         }
     }
 
-    /// Creates a new HOTP instance from a utf8-encoded string secret and the number of digits.
+    /// Creates a new HOTP instance from an utf8-encoded string secret and the number of digits.
     pub fn new_from_utf8(secret: &str, digits: u32) -> Self {
         HOTP::new(secret.as_bytes(), digits)
     }
@@ -57,16 +57,22 @@ impl HOTP {
         HOTP::new(&decoded, digits)
     }
 
-    /// Creates a new HOTP instance from a utf8-encoded string secret and a default number of 6 digits.
-    pub fn from_utf8(secret: &str) -> Self {
+    /// Creates a new HOTP instance from a byte-array representation of the secret and
+    /// a default number of 6 digits.
+    pub fn default_from_secret(secret: &[u8]) -> Self {
+        HOTP::new(secret, 6)
+    }
+
+    /// Creates a new HOTP instance from an utf8-encoded string secret and a default number of 6 digits.
+    pub fn default_from_utf8(secret: &str) -> Self {
         HOTP::new_from_utf8(secret, 6)
     }
 
     /// Creates a new HOTP instance from a base32-encoded string secret and a default number of 6 digits.
     ///
     /// # Panics
     /// This method panics if the provided string is not correctly base32 encoded.
-    pub fn from_base32(secret: &str) -> Self {
+    pub fn default_from_base32(secret: &str) -> Self {
         HOTP::new_from_base32(secret, 6)
     }
 }

src/lib.rs

@@ -14,7 +14,7 @@
 //!     let secret = "secret";
 //!     let counter = 0;
 //!     // Get a HOTP instance with a '&str' secret
-//!     let hotp_str = HOTP::from_utf8(secret);
+//!     let hotp_str = HOTP::default_from_utf8(secret);
 //!     // Get an otp with the given counter
 //!     let otp_from_str = hotp_str.get_otp(counter);
 //!     println!("The otp from hotp_str: {}", otp_from_str);
@@ -41,7 +41,7 @@
 //!         .expect("Error getting time")
 //!         .as_secs();
 //!     // Get a TOTP instance with an '&str' secret and default SHA1 Digest
-//!     let totp_sha1_str = TOTP::from_utf8(secret);
+//!     let totp_sha1_str = TOTP::default_from_utf8(secret);
 //!     // Get an otp with the given counter and elapsed seconds
 //!     let otp_sha1 = totp_sha1_str.get_otp(elapsed_seconds);
 //!     println!("The otp from totp_sha1_str: {}", otp_sha1);
@@ -52,7 +52,7 @@
 //!         secret.as_bytes(),
 //!         MacDigest::SHA256, // SHA256 algorithm
 //!         8,  // 8 digits
-//!         60  // 60 seconds interval
+//!         60  // 60-second interval
 //!     );
 //!     // Get an otp with the given counter, time and other custom params
 //!     let otp_sha256 = totp_sha256_bytes.get_otp_with_custom_time_start(

src/totp.rs

@@ -19,7 +19,7 @@ pub struct TOTP {
     /// The secret key used in the HMAC process.
     ///
     /// Often given as a Base32 key, which can be conveniently initialized using
-    /// [`TOTP::from_base32`] constructors.
+    /// [`TOTP::default_from_base32`] constructors.
     secret: Vec<u8>,
 
     /// The digest to use in the HMAC process.
@@ -71,31 +71,31 @@ impl TOTP {
     ///
     /// Defaults to using [`MacDigest::SHA1`] as the digest for HMAC operations,
     /// 6 digits and a 30 seconds period.
-    pub fn from_secret(secret: &[u8]) -> Self {
-        TOTP::from_secret_with_digest(secret, MacDigest::SHA1)
+    pub fn default_from_secret(secret: &[u8]) -> Self {
+        TOTP::default_from_secret_with_digest(secret, MacDigest::SHA1)
     }
 
     /// Creates a new TOTP instance with a byte-array representation of the secret and
     /// a digest algorithm.
     ///
     /// Defaults to using 6 digits and a 30 seconds period.
-    pub fn from_secret_with_digest(secret: &[u8], mac_digest: MacDigest) -> Self {
+    pub fn default_from_secret_with_digest(secret: &[u8], mac_digest: MacDigest) -> Self {
         TOTP::new(secret, mac_digest, 6, 30)
     }
 
     /// Creates a new TOTP instance with an utf8 representation of the secret.
     ///
     /// Defaults to using [`MacDigest::SHA1`] as the digest for HMAC operations,
     /// 6 digits and a 30 seconds period.
-    pub fn from_utf8(secret: &str) -> Self {
-        TOTP::from_utf8_with_digest(secret, MacDigest::SHA1)
+    pub fn default_from_utf8(secret: &str) -> Self {
+        TOTP::default_from_utf8_with_digest(secret, MacDigest::SHA1)
     }
 
     /// Creates a new TOTP instance with an utf8 representation of the secret and
     /// a digest algorithm.
     ///
     /// Defaults to using 6 digits and a 30 seconds period.
-    pub fn from_utf8_with_digest(secret: &str, mac_digest: MacDigest) -> Self {
+    pub fn default_from_utf8_with_digest(secret: &str, mac_digest: MacDigest) -> Self {
         TOTP::new_from_utf8(secret, mac_digest, 6, 30)
     }
 
@@ -106,8 +106,8 @@ impl TOTP {
     ///
     /// # Panics
     /// This method panics if the provided string is not correctly base32 encoded.
-    pub fn from_base32(secret: &str) -> Self {
-        TOTP::from_base32_with_digest(secret, MacDigest::SHA1)
+    pub fn default_from_base32(secret: &str) -> Self {
+        TOTP::default_from_base32_with_digest(secret, MacDigest::SHA1)
     }
 
     /// Creates a new TOTP instance with a base32 representation of the secret and
@@ -117,7 +117,7 @@ impl TOTP {
     ///
     /// # Panics
     /// This method panics if the provided string is not correctly base32 encoded.
-    pub fn from_base32_with_digest(secret: &str, mac_digest: MacDigest) -> Self {
+    pub fn default_from_base32_with_digest(secret: &str, mac_digest: MacDigest) -> Self {
         TOTP::new_from_base32(secret, mac_digest, 6, 30)
     }
 }

tests/hotp.rs

@@ -14,14 +14,14 @@ fn run_rfc_test_bytes(count: u64) -> u32 {
 /// Generic test method to get the HOTP code with
 /// the Secret Key as a string literal
 fn run_rfc_test_utf8(count: u64) -> u32 {
-    let hotp = HOTP::from_utf8(SECRET_UTF8);
+    let hotp = HOTP::default_from_utf8(SECRET_UTF8);
     hotp.get_otp(count)
 }
 
 /// Generic test method to get the HOTP code with
 /// the Secret Key as a base32-encoded string
 fn run_rfc_test_base32(count: u64) -> u32 {
-    let hotp = HOTP::from_base32(SECRET_BASE32);
+    let hotp = HOTP::default_from_base32(SECRET_BASE32);
     hotp.get_otp(count)
 }