Struct NegativeI32 

#[repr(C, align(4))]
pub struct NegativeI32 { /* private fields */ }

A signed value that is known to be negative.

This enables some memory layout optimization. For example, Option<NegativeI32> is the same size as i32.

Implementations

impl NegativeI32

pub const BITS: u32 = 32u32

The size of this negative integer type in bits.

This value is equal to i32::BITS.

pub const MIN: Self

The smallest value that can be represented by this negative integer type, equal to i32::MIN.

pub const MAX: Self

The largest value that can be represented by this negative integer type, -1.

pub const fn new(value: i32) -> Option<Self>

Creates a NegativeI32 if the given value is negative.

pub const unsafe fn new_unchecked(value: i32) -> Self

Creates a NegativeI32 without checking whether the value is negative. This results in undefined behaviour if the value is positive.

Safety

The value must not be positive.

pub const fn get(self) -> i32

Returns the contained value as a primitive type.

pub const fn count_zeros(self) -> u32

Returns the number of zeros in the binary representation of self.

pub const fn count_ones(self) -> u32

Returns the number of ones in the binary representation of self.

pub const fn leading_zeros(self) -> u32

Returns the number of leading zeros in the binary representation of self.

Since the value is guaranteed to be negative, this function always returns 0.

pub const fn trailing_zeros(self) -> u32

Returns the number of trailing zeros in the binary representation of self.

On many architectures, this function can perform better than trailing_zeros() on the underlying integer type, as special handling of zero can be avoided.

pub const fn checked_abs(self) -> Option<PositiveI32>

Checked absolute value. Computes -self, returning None if self == MIN.

pub const fn checked_neg(self) -> Option<PositiveI32>

Checked negation. Computes -self, returning None if self == MIN.

pub const fn checked_add(self, rhs: Self) -> Option<Self>

Checked addition. Adds a negative integer to another negative integer. Checks for overflow and returns None on overflow. As a consequence, the result cannot wrap to positive integers.

pub const fn checked_sub(self, rhs: Self) -> Option<Self>

Checked subtraction. Subtracts a negative integer from another negative integer. Returns None if the result would overflow into a positive integer.

pub const fn checked_mul(self, rhs: Self) -> Option<PositiveI32>

Checked multiplication. Multiplies a negative integer by another negative integer, returning a positive result. Returns None if the result would overflow.

pub const fn checked_mul_positive(self, rhs: PositiveI32) -> Option<Self>

Checked sign-preserving multiplication. Multiplies a negative integer by a positive integer, returning a negative result. Returns None if rhs == 0 or the result would overflow.

pub const fn checked_div(self, rhs: Self) -> Option<PositiveI32>

Checked division. Divides a negative integer by another negative integer, returning the positive quotient. Returns None if the result would overflow.

The only case where such an overflow can occur is when one divides MIN / -1; this is equivalent to -MIN, a positive value that is too large to represent as a PositiveI32.

pub const fn checked_div_euclid(self, rhs: Self) -> Option<PositiveI32>

Checked Euclidean division. Calculates the Euclidean quotient of two negative integers, returning the positive result. Returns None if the result would overflow.

The only case where such an overflow can occur is when one divides MIN / -1; this is equivalent to -MIN, a positive value that is too large to represent as a PositiveI32.

pub const fn checked_rem_euclid(self, rhs: i32) -> Option<PositiveI32>

Checked Euclidean remainder. Calculates the Euclidean remainder of a negative integer and any signed integer, returning the positive result. Returns None if rhs == 0 or the result would overflow.

The only case where such an overflow can occur is when one divides MIN / -1; this is equivalent to -MIN, a positive value that is too large to represent as a PositiveI32.

pub const fn saturating_abs(self) -> PositiveI32

Saturating absolute value. Computes -self, returning PositiveI32::MAX if self == MIN.

pub const fn saturating_neg(self) -> PositiveI32

Saturating negation. Computes -self, returning PositiveI32::MAX if self == MIN.

pub const fn saturating_add(self, rhs: Self) -> Self

Saturating addition. Adds a negative integer to another negative integer. Returns NegativeI32::MIN on overflow.

pub const fn saturating_sub(self, rhs: Self) -> Self

Saturating subtraction. Subtracts a negative integer from another negative integer. Returns -1 if the result would overflow into a positive integer.

pub const fn saturating_mul(self, rhs: Self) -> PositiveI32

Saturating multiplication. Multiplies a negative integer by another negative integer, returning a positive result. Returns PositiveI32::MAX on overflow.

pub const fn saturating_mul_positive(self, rhs: PositiveI32) -> Self

Saturating sign-preserving multiplication. Multiplies a negative integer by a positive integer, returning a negative result. Returns -1 if rhs == 0. Returns NegativeI32::MIN on overflow.

Trait Implementations

impl Binary for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<NegativeI32> for PositiveI32

type Output = PositiveI32

The resulting type after applying the & operator.

fn bitand(self, rhs: NegativeI32) -> Self::Output

Performs the & operation.

impl BitAnd<PositiveI32> for NegativeI32

type Output = PositiveI32

The resulting type after applying the & operator.

fn bitand(self, rhs: PositiveI32) -> Self::Output

Performs the & operation.

impl BitAnd for NegativeI32

type Output = NegativeI32

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<NegativeI32> for PositiveI32

fn bitand_assign(&mut self, rhs: NegativeI32)

Performs the &= operation.

impl BitAndAssign for NegativeI32

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<NegativeI32> for PositiveI32

type Output = NegativeI32

The resulting type after applying the | operator.

fn bitor(self, rhs: NegativeI32) -> Self::Output

Performs the | operation.

impl BitOr<NegativeI32> for i32

type Output = NegativeI32

The resulting type after applying the | operator.

fn bitor(self, rhs: NegativeI32) -> Self::Output

Performs the | operation.

impl BitOr<PositiveI32> for NegativeI32

type Output = NegativeI32

The resulting type after applying the | operator.

fn bitor(self, rhs: PositiveI32) -> Self::Output

Performs the | operation.

impl BitOr<i32> for NegativeI32

type Output = NegativeI32

The resulting type after applying the | operator.

fn bitor(self, rhs: i32) -> Self::Output

Performs the | operation.

impl BitOr for NegativeI32

type Output = NegativeI32

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<PositiveI32> for NegativeI32

fn bitor_assign(&mut self, rhs: PositiveI32)

Performs the |= operation.

impl BitOrAssign<i32> for NegativeI32

fn bitor_assign(&mut self, rhs: i32)

Performs the |= operation.

impl BitOrAssign for NegativeI32

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<NegativeI32> for PositiveI32

type Output = NegativeI32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: NegativeI32) -> Self::Output

Performs the ^ operation.

impl BitXor<PositiveI32> for NegativeI32

type Output = NegativeI32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: PositiveI32) -> Self::Output

Performs the ^ operation.

impl BitXor for NegativeI32

type Output = PositiveI32

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<PositiveI32> for NegativeI32

fn bitxor_assign(&mut self, rhs: PositiveI32)

Performs the ^= operation.

impl Clone for NegativeI32

fn clone(&self) -> NegativeI32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<NegativeI16> for NegativeI32

fn from(value: NegativeI16) -> Self

Converts to this type from the input type.

impl From<NegativeI32> for NegativeI64

fn from(value: NegativeI32) -> Self

Converts to this type from the input type.

impl From<NegativeI32> for i128

fn from(value: NegativeI32) -> Self

Converts to this type from the input type.

impl From<NegativeI32> for i32

fn from(value: NegativeI32) -> Self

Converts to this type from the input type.

impl From<NegativeI32> for i64

fn from(value: NegativeI32) -> Self

Converts to this type from the input type.

impl From<NegativeI8> for NegativeI32

fn from(value: NegativeI8) -> Self

Converts to this type from the input type.

impl FromStr for NegativeI32

type Err = IntErrorKind

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NegativeI32

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 LowerHex for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for NegativeI32

type Output = PositiveI32

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for NegativeI32

fn cmp(&self, rhs: &Self) -> 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 PartialEq for NegativeI32

fn eq(&self, rhs: &Self) -> 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 PartialOrd for NegativeI32

fn partial_cmp(&self, rhs: &Self) -> 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 TryFrom<NegativeI32> for NegativeI16

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI32> for NegativeI8

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI32> for NegativeIsize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI32> for i16

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI32> for i8

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI32> for isize

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<NegativeI64> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: NegativeI64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i128> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i8> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for NegativeI32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for NegativeI32

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for NegativeI32

impl Eq for NegativeI32