feat!: renamed unchecked_push* methods to push*_unchecked for mor…

…e conventional naming
bluurryy · Dec 22, 2024 · 24a9026 · 24a9026
1 parent 8de6fb6
commit 24a9026
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 30 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+- **breaking:** renamed `unchecked_push` to `push_unchecked`
+- **breaking:** renamed `unchecked_push_with` to `push_with_unchecked`
+
 ## 0.14.0 (2024-12-12)
 - **breaking:** fix `scoped_aligned`'s closure to take a `BumpScope` with `NEW_MIN_ALIGN` instead of `MIN_ALIGN`
 - **breaking:** `aligned`'s closure now takes a `BumpScope` with lifetime `'a` instead of `'_`

diff --git a/src/bump_scope.rs b/src/bump_scope.rs
@@ -1101,7 +1101,7 @@ where
         while vec.len() != vec.capacity() {
             match iter.next() {
                 // SAFETY: we checked above that `len != capacity`, so there is space
-                Some(value) => unsafe { vec.unchecked_push(value) },
+                Some(value) => unsafe { vec.push_unchecked(value) },
                 None => break,
             }
         }

diff --git a/src/bump_vec.rs b/src/bump_vec.rs
@@ -306,10 +306,10 @@ impl<T, A: BumpAllocator> BumpVec<T, A> {
             unsafe {
                 if count != 0 {
                     for _ in 0..(count - 1) {
-                        vec.unchecked_push_with(|| value.clone());
+                        vec.push_with_unchecked(|| value.clone());
                     }
 
-                    vec.unchecked_push_with(|| value);
+                    vec.push_with_unchecked(|| value);
                 }
             }
 
@@ -429,7 +429,7 @@ impl<T, A: BumpAllocator> BumpVec<T, A> {
             while vec.len() != vec.capacity() {
                 match iter.next() {
                     // SAFETY: we checked above that `len != capacity`, so there is space
-                    Some(value) => unsafe { vec.unchecked_push(value) },
+                    Some(value) => unsafe { vec.push_unchecked(value) },
                     None => break,
                 }
             }
@@ -707,17 +707,17 @@ impl<T, A: BumpAllocator> BumpVec<T, A> {
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push(&mut self, value: T) {
-        unsafe { self.fixed.cook_mut() }.unchecked_push(value);
+    pub unsafe fn push_unchecked(&mut self, value: T) {
+        unsafe { self.fixed.cook_mut() }.push_unchecked(value);
     }
 
     /// Appends an element to the back of the collection.
     ///
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push_with(&mut self, f: impl FnOnce() -> T) {
-        unsafe { self.fixed.cook_mut() }.unchecked_push_with(f);
+    pub unsafe fn push_with_unchecked(&mut self, f: impl FnOnce() -> T) {
+        unsafe { self.fixed.cook_mut() }.push_with_unchecked(f);
     }
 
     /// Forces the length of the vector to `new_len`.
@@ -781,7 +781,7 @@ impl<T, A: BumpAllocator> BumpVec<T, A> {
         use fn generic_push_with(&mut self, f: impl FnOnce() -> T) {
             self.generic_reserve_one()?;
             unsafe {
-                self.unchecked_push_with(f);
+                self.push_with_unchecked(f);
             }
             Ok(())
         }
@@ -1032,7 +1032,7 @@ impl<T, A: BumpAllocator> BumpVec<T, A> {
                     let fake = ManuallyDrop::new(MaybeUninit::<T>::uninit().assume_init());
 
                     for _ in 0..count {
-                        self.unchecked_push((*fake).clone());
+                        self.push_unchecked((*fake).clone());
                     }
 
                     return Ok(());

diff --git a/src/fixed_bump_vec.rs b/src/fixed_bump_vec.rs
@@ -453,7 +453,7 @@ impl<'a, T> FixedBumpVec<'a, T> {
         use fn generic_push_with(&mut self, f: impl FnOnce() -> T) {
             self.generic_reserve_one()?;
             unsafe {
-                self.unchecked_push_with(f);
+                self.push_with_unchecked(f);
             }
             Ok(())
         }
@@ -711,7 +711,7 @@ impl<'a, T> FixedBumpVec<'a, T> {
                     let fake = ManuallyDrop::new(MaybeUninit::<T>::uninit().assume_init());
 
                     for _ in 0..count {
-                        self.unchecked_push((*fake).clone());
+                        self.push_unchecked((*fake).clone());
                     }
 
                     return Ok(());
@@ -1081,16 +1081,16 @@ impl<'a, T> FixedBumpVec<'a, T> {
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push(&mut self, value: T) {
-        self.unchecked_push_with(|| value);
+    pub unsafe fn push_unchecked(&mut self, value: T) {
+        self.push_with_unchecked(|| value);
     }
 
     /// Appends an element to the back of the collection.
     ///
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push_with(&mut self, f: impl FnOnce() -> T) {
+    pub unsafe fn push_with_unchecked(&mut self, f: impl FnOnce() -> T) {
         debug_assert!(!self.is_full());
 
         let ptr = self.as_mut_ptr().add(self.len());

diff --git a/src/mut_bump_vec.rs b/src/mut_bump_vec.rs
@@ -392,17 +392,17 @@ impl<T, A> MutBumpVec<T, A> {
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push(&mut self, value: T) {
-        unsafe { self.fixed.cook_mut() }.unchecked_push(value);
+    pub unsafe fn push_unchecked(&mut self, value: T) {
+        unsafe { self.fixed.cook_mut() }.push_unchecked(value);
     }
 
     /// Appends an element to the back of the collection.
     ///
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push_with(&mut self, f: impl FnOnce() -> T) {
-        unsafe { self.fixed.cook_mut() }.unchecked_push_with(f);
+    pub unsafe fn push_with_unchecked(&mut self, f: impl FnOnce() -> T) {
+        unsafe { self.fixed.cook_mut() }.push_with_unchecked(f);
     }
 
     /// Forces the length of the vector to `new_len`.
@@ -490,10 +490,10 @@ impl<T, A: MutBumpAllocator> MutBumpVec<T, A> {
             unsafe {
                 if count != 0 {
                     for _ in 0..(count - 1) {
-                        vec.unchecked_push_with(|| value.clone());
+                        vec.push_with_unchecked(|| value.clone());
                     }
 
-                    vec.unchecked_push_with(|| value);
+                    vec.push_with_unchecked(|| value);
                 }
             }
 
@@ -610,7 +610,7 @@ impl<T, A: MutBumpAllocator> MutBumpVec<T, A> {
         use fn generic_push_with(&mut self, f: impl FnOnce() -> T) {
             self.generic_reserve_one()?;
             unsafe {
-                self.unchecked_push_with(f);
+                self.push_with_unchecked(f);
             }
             Ok(())
         }
@@ -862,7 +862,7 @@ impl<T, A: MutBumpAllocator> MutBumpVec<T, A> {
                     let fake = ManuallyDrop::new(MaybeUninit::<T>::uninit().assume_init());
 
                     for _ in 0..count {
-                        self.unchecked_push((*fake).clone());
+                        self.push_unchecked((*fake).clone());
                     }
 
                     return Ok(());

diff --git a/src/mut_bump_vec_rev.rs b/src/mut_bump_vec_rev.rs
@@ -217,16 +217,16 @@ impl<T, A> MutBumpVecRev<T, A> {
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push(&mut self, value: T) {
-        self.unchecked_push_with(|| value);
+    pub unsafe fn push_unchecked(&mut self, value: T) {
+        self.push_with_unchecked(|| value);
     }
 
     /// Appends an element to the back of the collection.
     ///
     /// # Safety
     /// Vector must not be full.
     #[inline(always)]
-    pub unsafe fn unchecked_push_with(&mut self, f: impl FnOnce() -> T) {
+    pub unsafe fn push_with_unchecked(&mut self, f: impl FnOnce() -> T) {
         debug_assert!(self.len < self.cap);
 
         let ptr = nonnull::sub(self.end, self.len + 1);
@@ -575,10 +575,10 @@ impl<T, A: MutBumpAllocator> MutBumpVecRev<T, A> {
             unsafe {
                 if count != 0 {
                     for _ in 0..(count - 1) {
-                        vec.unchecked_push_with(|| value.clone());
+                        vec.push_with_unchecked(|| value.clone());
                     }
 
-                    vec.unchecked_push_with(|| value);
+                    vec.push_with_unchecked(|| value);
                 }
             }
 
@@ -707,7 +707,7 @@ impl<T, A: MutBumpAllocator> MutBumpVecRev<T, A> {
         use fn generic_push_with(&mut self, f: impl FnOnce() -> T) {
             self.generic_reserve_one()?;
             unsafe {
-                self.unchecked_push_with(f);
+                self.push_with_unchecked(f);
             }
             Ok(())
         }
@@ -1280,7 +1280,7 @@ impl<T, A: MutBumpAllocator> MutBumpVecRev<T, A> {
                     let fake = ManuallyDrop::new(MaybeUninit::<T>::uninit().assume_init());
 
                     for _ in 0..count {
-                        self.unchecked_push((*fake).clone());
+                        self.push_unchecked((*fake).clone());
                     }
 
                     return Ok(());