From c1df7e9f85204469202047d8accf01c16110a3e2 Mon Sep 17 00:00:00 2001
From: "Tony Arcieri (iqlusion)" <tony@iqlusion.io>
Date: Tue, 17 Sep 2024 12:36:56 -0600
Subject: [PATCH] secrecy: rename constructor methods to `init_with` (#1212)

Previously they were named `*new_with_ctr` which is a somewhat confusing
name (particularly to anyone who works in cryptography where "ctr"
registers as counter mode).

The `init_with` name is commonly used for these sorts of `Fn`-based
constructors.
---
 secrecy/src/lib.rs | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/secrecy/src/lib.rs b/secrecy/src/lib.rs
index d64d1540..ec351d8d 100644
--- a/secrecy/src/lib.rs
+++ b/secrecy/src/lib.rs
@@ -106,7 +106,7 @@ impl<S: Zeroize + Clone> SecretBox<S> {
     ///
     /// **Note:** using [`Self::new`] or [`Self::new_with_mut`] is preferable when possible,
     /// since this method's safety relies on empyric evidence and may be violated on some targets.
-    pub fn new_with_ctr(ctr: impl FnOnce() -> S) -> Self {
+    pub fn init_with(ctr: impl FnOnce() -> S) -> Self {
         let mut data = ctr();
         let secret = Self {
             inner_secret: Box::new(data.clone()),
@@ -115,12 +115,12 @@ impl<S: Zeroize + Clone> SecretBox<S> {
         secret
     }
 
-    /// Same as [`Self::new_with_ctr`], but the constructor can be fallible.
+    /// Same as [`Self::init_with`], but the constructor can be fallible.
     ///
     ///
     /// **Note:** using [`Self::new`] or [`Self::new_with_mut`] is preferable when possible,
     /// since this method's safety relies on empyric evidence and may be violated on some targets.
-    pub fn try_new_with_ctr<E>(ctr: impl FnOnce() -> Result<S, E>) -> Result<Self, E> {
+    pub fn try_init_with<E>(ctr: impl FnOnce() -> Result<S, E>) -> Result<Self, E> {
         let mut data = ctr()?;
         let secret = Self {
             inner_secret: Box::new(data.clone()),
@@ -209,7 +209,7 @@ where
     where
         D: de::Deserializer<'de>,
     {
-        Self::try_new_with_ctr(|| T::deserialize(deserializer))
+        Self::try_init_with(|| T::deserialize(deserializer))
     }
 }