Struct Saturating

pub struct Saturating<T>(pub T);

Natural numbers with saturating arithmetic

In contrast to std::num::Saturating, T::MAX represents an out-of-bounds value, and a subsequent subtraction or right shift does not change this value.

Tuple Fields

0: T

Trait Implementations

impl<'a> AddAssign<&'a Saturating<u128>> for Saturating<u128>

fn add_assign(&mut self, rhs: &'a Self)

Performs the += operation.

impl<'a> AddAssign<&'a Saturating<u64>> for Saturating<u64>

fn add_assign(&mut self, rhs: &'a Self)

Performs the += operation.

impl<T: Clone> Clone for Saturating<T>

fn clone(&self) -> Saturating<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: From<u32>> From<u32> for Saturating<T>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Saturating<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> IsFloatingPoint for Saturating<T>

cbindgen:ignore

const FLOATING_POINT: bool = false

true iff the underlying type is a floating point number

const MIN_EXP: i32 = 0i32

One greater than the minimum possible normal power of 2 exponent, see f64::MIN_EXP for instance. 0 for integers

impl<T: Ord> Ord for Saturating<T>

fn cmp(&self, other: &Saturating<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Saturating<T>

fn eq(&self, other: &Saturating<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Saturating<T>

fn partial_cmp(&self, other: &Saturating<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ShlAssign<u32> for Saturating<u128>

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl ShlAssign<u32> for Saturating<u64>

fn shl_assign(&mut self, rhs: u32)

Performs the <<= operation.

impl ShrAssign<u32> for Saturating<u128>

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl ShrAssign<u32> for Saturating<u64>

fn shr_assign(&mut self, rhs: u32)

Performs the >>= operation.

impl<'a> SubAssign<&'a Saturating<u128>> for Saturating<u128>

fn sub_assign(&mut self, rhs: &'a Self)

Performs the -= operation.

impl<'a> SubAssign<&'a Saturating<u64>> for Saturating<u64>

fn sub_assign(&mut self, rhs: &'a Self)

Performs the -= operation.

impl<T: Copy> Copy for Saturating<T>

impl<T: Eq> Eq for Saturating<T>

impl<T> StructuralPartialEq for Saturating<T>