Use Panic for associated type rather than ! for clarity

Author: Ericson2314

src/alloc/abort.rs

@@ -24,6 +24,12 @@ use core::ptr::NonNull;
 #[derive(Copy, Clone, Debug, Default)]
 pub struct AbortAlloc<Alloc>(pub Alloc);
 
+/// A synonym used to indicate the impossible case will be a panic instead.
+///
+/// `!` in rust really does mean "never" / "impossible", but nothing in the type
+/// system tracks panicking.
+pub type Panic = !;
+
 impl<A: BuildAllocRef> BuildAllocRef for AbortAlloc<A> {
     type Ref = AbortAlloc<A::Ref>;
 
@@ -49,7 +55,7 @@ impl<A: DeallocRef> DeallocRef for AbortAlloc<A> {
 }
 
 impl<A: AllocRef> AllocRef for AbortAlloc<A> {
-    type Error = !;
+    type Error = Panic;
 
     fn alloc(&mut self, layout: NonZeroLayout) -> Result<NonNull<u8>, Self::Error> {
         self.0

src/alloc/mod.rs

@@ -2,7 +2,7 @@ mod abort;
 mod layout;
 
 pub use self::{
-    abort::AbortAlloc,
+    abort::{AbortAlloc, Panic},
     layout::{LayoutErr, NonZeroLayout},
 };
 pub use core::alloc::GlobalAlloc;

src/boxed.rs

@@ -79,7 +79,7 @@
 //! [`NonZeroLayout::for_value(&*value)`]: crate::alloc::NonZeroLayout::for_value
 
 use crate::{
-    alloc::{AbortAlloc, AllocRef, BuildAllocRef, DeallocRef, Global, NonZeroLayout},
+    alloc::{AbortAlloc, AllocRef, BuildAllocRef, DeallocRef, Global, NonZeroLayout, Panic},
     clone::CloneIn,
     collections::CollectionAllocErr,
     raw_vec::RawVec,
@@ -188,7 +188,7 @@ impl<T, A: AllocRef> Box<T, A> {
     #[inline(always)]
     pub fn new_in(x: T, a: A) -> Self
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         let Ok(b) = Self::try_new_in(x, a);
         b
@@ -245,7 +245,7 @@ impl<T, A: AllocRef> Box<T, A> {
     #[inline(always)]
     pub fn new_uninit_in(a: A) -> Box<mem::MaybeUninit<T>, A>
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         let Ok(b) = Self::try_new_uninit_in(a);
         b
@@ -286,7 +286,7 @@ impl<T, A: AllocRef> Box<T, A> {
     #[inline(always)]
     pub fn pin_in(x: T, a: A) -> Pin<Self>
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         let Ok(b) = Self::try_pin_in(x, a);
         b
@@ -331,7 +331,7 @@ impl<T> Box<[T]> {
 }
 
 #[allow(clippy::use_self)]
-impl<T, A: AllocRef<Error = !>> Box<[T], A> {
+impl<T, A: AllocRef<Error = Panic>> Box<[T], A> {
     /// Construct a new boxed slice with uninitialized contents with the spoecified allocator.
     ///
     /// # Example
@@ -775,7 +775,7 @@ unsafe impl<#[may_dangle] T: ?Sized, A: DeallocRef> Drop for Box<T, A> {
 impl<T, A> Default for Box<T, A>
 where
     T: Default,
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     #[must_use]
     fn default() -> Self {
@@ -784,9 +784,9 @@ where
 }
 
 #[allow(clippy::use_self)]
-impl<T, A: AllocRef<Error = !>> Default for Box<[T], A>
+impl<T, A: AllocRef<Error = Panic>> Default for Box<[T], A>
 where
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     #[must_use]
     fn default() -> Self {
@@ -801,19 +801,19 @@ unsafe fn from_boxed_utf8_unchecked<A: DeallocRef>(v: Box<[u8], A>) -> Box<str,
 }
 
 #[allow(clippy::use_self)]
-impl<A: AllocRef<Error = !>> Default for Box<str, A>
+impl<A: AllocRef<Error = Panic>> Default for Box<str, A>
 where
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     #[must_use]
     fn default() -> Self {
         unsafe { from_boxed_utf8_unchecked(Box::default()) }
     }
 }
 
-impl<T: Clone, A: AllocRef<Error = !>> Clone for Box<T, A>
+impl<T: Clone, A: AllocRef<Error = Panic>> Clone for Box<T, A>
 where
-    A: AllocRef<Error = !>,
+    A: AllocRef<Error = Panic>,
     A::BuildAlloc: Clone,
 {
     /// Returns a new box with a `clone()` of this box's contents.
@@ -876,7 +876,7 @@ impl<T: Clone, A: AllocRef, B: AllocRef> CloneIn<B> for Box<T, A> {
 
     fn clone_in(&self, a: B) -> Self::Cloned
     where
-        B: AllocRef<Error = !>,
+        B: AllocRef<Error = Panic>,
     {
         Box::new_in(self.as_ref().clone(), a)
     }
@@ -978,9 +978,9 @@ impl<T: ?Sized + Hasher, A: DeallocRef> Hasher for Box<T, A> {
     }
 }
 
-impl<T, A: AllocRef<Error = !>> From<T> for Box<T, A>
+impl<T, A: AllocRef<Error = Panic>> From<T> for Box<T, A>
 where
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     /// Converts a generic type `T` into a `Box<T>`
     ///
@@ -1014,7 +1014,7 @@ impl<T: ?Sized, A: DeallocRef> From<Box<T, A>> for Pin<Box<T, A>> {
 #[allow(clippy::use_self)]
 impl<T: Copy, A> From<&[T]> for Box<[T], A>
 where
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     /// Converts a `&[T]` into a `Box<[T], B>`
     ///
@@ -1043,7 +1043,7 @@ where
 #[allow(clippy::use_self)]
 impl<A> From<&str> for Box<str, A>
 where
-    A: Default + AllocRef<Error = !>,
+    A: Default + AllocRef<Error = Panic>,
 {
     /// Converts a `&str` into a `Box<str>`
     ///
@@ -1306,7 +1306,7 @@ impl_dispatch_from_dyn!(AbortAlloc<std::alloc::System>);
 #[allow(clippy::items_after_statements)]
 impl<T: Clone, A: Clone> Clone for Box<[T], A>
 where
-    A: AllocRef<Error = !>,
+    A: AllocRef<Error = Panic>,
     A::BuildAlloc: Clone,
 {
     fn clone(&self) -> Self {

src/clone.rs

@@ -1,11 +1,11 @@
-use crate::alloc::AllocRef;
+use crate::alloc::{AllocRef, Panic};
 
 pub trait CloneIn<A: AllocRef>: Sized {
     type Cloned;
 
     fn clone_in(&self, a: A) -> Self::Cloned
     where
-        A: AllocRef<Error = !>;
+        A: AllocRef<Error = Panic>;
 
     fn try_clone_in(&self, a: A) -> Result<Self::Cloned, A::Error>;
 }

src/iter.rs

@@ -1,4 +1,7 @@
-use crate::{alloc::AllocRef, collections::CollectionAllocErr};
+use crate::{
+    alloc::{AllocRef, Panic},
+    collections::CollectionAllocErr,
+};
 
 /// Extend a collection "fallibly" with the contents of an iterator.
 pub trait TryExtend<A> {
@@ -27,7 +30,7 @@ pub trait TryExtend<A> {
 pub trait FromIteratorIn<T, A: AllocRef> {
     fn from_iter_in<I: IntoIterator<Item = T>>(iter: I, allocator: A) -> Self
     where
-        A: AllocRef<Error = !>;
+        A: AllocRef<Error = Panic>;
 
     fn try_from_iter_in<I: IntoIterator<Item = T>>(
         iter: I,
@@ -42,7 +45,7 @@ pub trait IteratorExt: Iterator + Sized {
     #[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
     fn collect_in<T: FromIteratorIn<Self::Item, A>, A: AllocRef>(self, allocator: A) -> T
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         FromIteratorIn::from_iter_in(self, allocator)
     }

src/raw_vec.rs

@@ -7,6 +7,7 @@ use crate::{
         DeallocRef,
         Global,
         NonZeroLayout,
+        Panic,
         ReallocRef,
     },
     boxed::Box,
@@ -162,7 +163,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// * on 32-bit platforms if the requested capacity exceeds `isize::MAX` bytes.
     pub fn with_capacity_in(capacity: usize, a: A) -> Self
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         match Self::try_with_capacity_in(capacity, a) {
             Ok(vec) => vec,
@@ -198,7 +199,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// * on 32-bit platforms if the requested capacity exceeds `isize::MAX` bytes.
     pub fn with_capacity_zeroed_in(capacity: usize, a: A) -> Self
     where
-        A: AllocRef<Error = !>,
+        A: AllocRef<Error = Panic>,
     {
         match Self::try_with_capacity_zeroed_in(capacity, a) {
             Ok(vec) => vec,
@@ -419,7 +420,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// ```
     pub fn double(&mut self)
     where
-        A: ReallocRef<Error = !>,
+        A: ReallocRef<Error = Panic>,
     {
         match self.try_double() {
             Ok(_) => (),
@@ -590,7 +591,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// ```
     pub fn reserve(&mut self, used_capacity: usize, needed_extra_capacity: usize)
     where
-        A: ReallocRef<Error = !>,
+        A: ReallocRef<Error = Panic>,
     {
         match self.try_reserve(used_capacity, needed_extra_capacity) {
             Ok(vec) => vec,
@@ -634,7 +635,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// * on 32-bit platforms if the requested capacity exceeds `isize::MAX` bytes.
     pub fn reserve_exact(&mut self, used_capacity: usize, needed_extra_capacity: usize)
     where
-        A: ReallocRef<Error = !>,
+        A: ReallocRef<Error = Panic>,
     {
         match self.try_reserve_exact(used_capacity, needed_extra_capacity) {
             Ok(_) => (),
@@ -736,7 +737,7 @@ impl<T, A: DeallocRef> RawVec<T, A> {
     /// Panics if the given amount is *larger* than the current capacity.
     pub fn shrink_to_fit(&mut self, amount: usize)
     where
-        A: ReallocRef<Error = !>,
+        A: ReallocRef<Error = Panic>,
     {
         match self.try_shrink_to_fit(amount) {
             Ok(_) => (),