Add Error::saturate()

Author: AldaronLau

src/error.rs

@@ -28,3 +28,33 @@ impl fmt::Display for Error {
         }
     }
 }
+
+impl Error {
+    /// Saturate out of bounds values.
+    ///
+    /// ```rust
+    /// # use ranch::{RangedU8, Error};
+    /// assert_eq!(
+    ///     RangedU8::<1, 3>::new(0).unwrap_or_else(Error::saturate),
+    ///     RangedU8::<1, 3>::new_const::<1>(),
+    /// );
+    /// assert_eq!(
+    ///     RangedU8::<1, 3>::new(4).unwrap_or_else(Error::saturate),
+    ///     RangedU8::<1, 3>::new_const::<3>(),
+    /// );
+    /// ```
+    pub const fn saturate<T>(self) -> T
+    where
+        T: Saturate,
+    {
+        match self {
+            Self::PosOverflow => T::MAX,
+            Self::NegOverflow => T::MIN,
+        }
+    }
+}
+
+pub trait Saturate {
+    const MIN: Self;
+    const MAX: Self;
+}

src/ranged_u128.rs

@@ -292,3 +292,10 @@ impl<const MIN: u128, const MAX: u128> core::str::FromStr
         Self::new(parsed).map_err(From::from)
     }
 }
+
+impl<const MIN: u128, const MAX: u128> crate::error::Saturate
+    for RangedU128<MIN, MAX>
+{
+    const MAX: Self = Self::MAX;
+    const MIN: Self = Self::MIN;
+}

src/ranged_u16.rs

@@ -292,3 +292,10 @@ impl<const MIN: u16, const MAX: u16> core::str::FromStr
         Self::new(parsed).map_err(From::from)
     }
 }
+
+impl<const MIN: u16, const MAX: u16> crate::error::Saturate
+    for RangedU16<MIN, MAX>
+{
+    const MAX: Self = Self::MAX;
+    const MIN: Self = Self::MIN;
+}

src/ranged_u32.rs

@@ -292,3 +292,10 @@ impl<const MIN: u32, const MAX: u32> core::str::FromStr
         Self::new(parsed).map_err(From::from)
     }
 }
+
+impl<const MIN: u32, const MAX: u32> crate::error::Saturate
+    for RangedU32<MIN, MAX>
+{
+    const MAX: Self = Self::MAX;
+    const MIN: Self = Self::MIN;
+}

src/ranged_u64.rs

@@ -292,3 +292,10 @@ impl<const MIN: u64, const MAX: u64> core::str::FromStr
         Self::new(parsed).map_err(From::from)
     }
 }
+
+impl<const MIN: u64, const MAX: u64> crate::error::Saturate
+    for RangedU64<MIN, MAX>
+{
+    const MAX: Self = Self::MAX;
+    const MIN: Self = Self::MIN;
+}

src/ranged_u8.rs

@@ -290,3 +290,10 @@ impl<const MIN: u8, const MAX: u8> core::str::FromStr for RangedU8<MIN, MAX> {
         Self::new(parsed).map_err(From::from)
     }
 }
+
+impl<const MIN: u8, const MAX: u8> crate::error::Saturate
+    for RangedU8<MIN, MAX>
+{
+    const MAX: Self = Self::MAX;
+    const MIN: Self = Self::MIN;
+}