Struct Int 

pub struct Int<T: SignedInteger + BuiltinInteger, const BITS: usize> { /* private fields */ }

Implementations

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Int<T, BITS>

pub const BITS: usize = BITS

pub const fn value(self) -> T

Returns the type as a fundamental data type.

Note that if negative, the returned value may span more bits than BITS, as it preserves the numeric value instead of the bitwise value:

let value: i8 = i3::new(-1).value();
assert_eq!(value, -1);
assert_eq!(value.count_ones(), 8);

If you need a value within the specified bit range, use Self::to_bits.

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

Initializes a new value without checking the bounds

Safety

Must only be called with a value bigger or equal to Self::MIN and less than or equal to Self::MAX.

impl<const BITS: usize> Int<i8, BITS>

pub const MASK: i8

pub const fn new(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i8(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i16(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i32(value: i32) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i64(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i128(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn try_new(value: i8) -> Result<Self, TryNewError>

Creates an instance or an error if the given value is outside of the valid range

pub const fn to_bits(self) -> u8

Returns the bitwise representation of the value.

As the bit width is limited to BITS the numeric value may differ from value.

let value = i3::new(-1);
assert_eq!(value.to_bits(), 0b111); // 7
assert_eq!(value.value(), -1);

To convert from the bitwise representation back to an instance, use from_bits.

pub const fn from_bits(value: u8) -> Self

Convert the bitwise representation from to_bits to an instance.

let value = i3::from_bits(0b111);
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use new.

Panics

Panics if the given value exceeds the bit width specified by BITS.

pub const fn try_from_bits(value: u8) -> Result<Self, TryNewError>

Tries to convert the bitwise representation from to_bits to an instance.

i3::try_from_bits(0b1111).expect_err("value is > 3 bits");
let value = i3::try_from_bits(0b111).expect("value is <= 3 bits");
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use try_new.

Errors

Returns an error if the given value exceeds the bit width specified by BITS.

pub const unsafe fn from_bits_unchecked(value: u8) -> Self

Converts the bitwise representation from to_bits to an instance, without checking the bounds.

Safety

The given value must not exceed the bit width specified by Self::BITS.

pub const fn extract_i8(value: i8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i8, i.e. it is greater than 8.

pub const fn extract_u8(value: u8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u8, i.e. it is greater than 8.

pub const fn extract_i16(value: i16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i16, i.e. it is greater than 16.

pub const fn extract_u16(value: u16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u16, i.e. it is greater than 16.

pub const fn extract_i32(value: i32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i32, i.e. it is greater than 32.

pub const fn extract_u32(value: u32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u32, i.e. it is greater than 32.

pub const fn extract_i64(value: i64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i64, i.e. it is greater than 64.

pub const fn extract_u64(value: u64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u64, i.e. it is greater than 64.

pub const fn extract_i128(value: i128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i128, i.e. it is greater than 128.

pub const fn extract_u128(value: u128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u128, i.e. it is greater than 128.

pub const fn widen<const BITS_RESULT: usize>(self) -> Int<i8, BITS_RESULT>

Returns an Int with a wider bit depth but with the same base data type

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_add(i14::new(27)), i14::new(127));
assert_eq!(i14::MAX.wrapping_add(i14::new(2)), i14::MIN + i14::new(1));

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(0).wrapping_sub(i14::new(127)), i14::new(-127));
assert_eq!(i14::new(-2).wrapping_sub(i14::MAX), i14::MAX);

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(10).wrapping_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::new(12).wrapping_mul(i14::new(1024)), i14::new(-4096));

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

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_div(i14::new(10)), i14::new(10));
assert_eq!(i14::MIN.wrapping_div(i14::new(-1)), i14::MIN);

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_neg(), i14::new(-100));
assert_eq!(i14::new(-100).wrapping_neg(), i14::new(100));
assert_eq!(i14::MIN.wrapping_neg(), i14::MIN);

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

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_left function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-1).wrapping_shl(7), i14::new(-128));
assert_eq!(i14::new(-1).wrapping_shl(128), i14::new(-4));

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

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_right function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-128).wrapping_shr(7), i14::new(-1));
assert_eq!(i14::new(-128).wrapping_shr(60), i14::new(-8));

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_add(i14::new(1)), i14::new(101));
assert_eq!(i14::MAX.saturating_add(i14::new(100)), i14::MAX);
assert_eq!(i14::MIN.saturating_add(i14::new(-1)), i14::MIN);

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_sub(i14::new(127)), i14::new(-27));
assert_eq!(i14::MIN.saturating_sub(i14::new(100)), i14::MIN);
assert_eq!(i14::MAX.saturating_sub(i14::new(-1)), i14::MAX);

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(10).saturating_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::MAX.saturating_mul(i14::new(10)), i14::MAX);
assert_eq!(i14::MIN.saturating_mul(i14::new(10)), i14::MIN);

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).saturating_div(i14::new(2)), i14::new(2));
assert_eq!(i14::MAX.saturating_div(i14::new(-1)), i14::MIN + i14::new(1));
assert_eq!(i14::MIN.saturating_div(i14::new(-1)), i14::MAX);

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_neg(), i14::new(-100));
assert_eq!(i14::new(-100).saturating_neg(), i14::new(100));
assert_eq!(i14::MIN.saturating_neg(), i14::MAX);
assert_eq!(i14::MAX.saturating_neg(), i14::MIN + i14::new(1));

pub const fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(-4).saturating_pow(3), i14::new(-64));
assert_eq!(i14::MIN.saturating_pow(2), i14::MAX);
assert_eq!(i14::MIN.saturating_pow(3), i14::MIN);

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(1)), Some(i14::MAX - i14::new(1)));
assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(3)), None);

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(1)), Some(i14::MIN + i14::new(1)));
assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(3)), None);

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(i14::MAX.checked_mul(i14::new(1)), Some(i14::MAX));
assert_eq!(i14::MAX.checked_mul(i14::new(2)), None);

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(1)).checked_div(i14::new(-1)), Some(i14::new(8191)));
assert_eq!(i14::MIN.checked_div(i14::new(-1)), None);
assert_eq!((i14::new(1)).checked_div(i14::new(0)), None);

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

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

Examples

Basic usage:

assert_eq!(i14::new(5).checked_neg(), Some(i14::new(-5)));
assert_eq!(i14::MIN.checked_neg(), None);

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

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x1).checked_shl(4), Some(i14::new(0x10)));
assert_eq!(i14::new(0x1).checked_shl(129), None);
assert_eq!(i14::new(0x10).checked_shl(13), Some(i14::new(0)));

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

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x10).checked_shr(4), Some(i14::new(0x1)));
assert_eq!(i14::new(0x10).checked_shr(129), None);

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

Calculates self + rhs.

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_add(i14::new(2)), (i14::new(7), false));
assert_eq!(i14::MAX.overflowing_add(i14::new(1)), (i14::MIN, true));

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

Calculates self - rhs.

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_sub(i14::new(2)), (i14::new(3), false));
assert_eq!(i14::MIN.overflowing_sub(i14::new(1)), (i14::MAX, true));

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_mul(i14::new(2)), (i14::new(10), false));
assert_eq!(i14::new(1_000).overflowing_mul(i14::new(10)), (i14::new(-6384), true));

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_div(i14::new(2)), (i14::new(2), false));
assert_eq!(i14::MIN.overflowing_div(i14::new(-1)), (i14::MIN, true));

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i14::MIN for values of type i14), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(i14::new(2).overflowing_neg(), (i14::new(-2), false));
assert_eq!(i14::MIN.overflowing_neg(), (i14::MIN, true));

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x1).overflowing_shl(4), (i14::new(0x10), false));
assert_eq!(i14::new(0x1).overflowing_shl(15), (i14::new(0x2), true));
assert_eq!(i14::new(0x10).overflowing_shl(13), (i14::new(0), false));

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x10).overflowing_shr(4), (i14::new(0x1), false));
assert_eq!(i14::new(0x10).overflowing_shr(15), (i14::new(0x8), true));

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(i14::new(10).is_positive());
assert!(!i14::new(-10).is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(i14::new(-10).is_negative());
assert!(!i14::new(10).is_negative());

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

Examples

Basic usage:

assert_eq!(i6::from_bits(0b10_1010).reverse_bits(), i6::from_bits(0b01_0101));
assert_eq!(i6::new(0), i6::new(0).reverse_bits());

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::from_bits(0b00_1000);
assert_eq!(n.count_ones(), 1);

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

assert_eq!(i6::MAX.count_zeros(), 1);

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_ones(), 6);

pub const fn leading_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(3);
assert_eq!(n.trailing_ones(), 2);

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-4);
assert_eq!(n.trailing_zeros(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_left(1), m);

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_right(1), m);

impl<const BITS: usize> Int<i16, BITS>

pub const MASK: i16

pub const fn new(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i8(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i16(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i32(value: i32) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i64(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i128(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn try_new(value: i16) -> Result<Self, TryNewError>

Creates an instance or an error if the given value is outside of the valid range

pub const fn to_bits(self) -> u16

Returns the bitwise representation of the value.

As the bit width is limited to BITS the numeric value may differ from value.

let value = i3::new(-1);
assert_eq!(value.to_bits(), 0b111); // 7
assert_eq!(value.value(), -1);

To convert from the bitwise representation back to an instance, use from_bits.

pub const fn from_bits(value: u16) -> Self

Convert the bitwise representation from to_bits to an instance.

let value = i3::from_bits(0b111);
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use new.

Panics

Panics if the given value exceeds the bit width specified by BITS.

pub const fn try_from_bits(value: u16) -> Result<Self, TryNewError>

Tries to convert the bitwise representation from to_bits to an instance.

i3::try_from_bits(0b1111).expect_err("value is > 3 bits");
let value = i3::try_from_bits(0b111).expect("value is <= 3 bits");
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use try_new.

Errors

Returns an error if the given value exceeds the bit width specified by BITS.

pub const unsafe fn from_bits_unchecked(value: u16) -> Self

Converts the bitwise representation from to_bits to an instance, without checking the bounds.

Safety

The given value must not exceed the bit width specified by Self::BITS.

pub const fn extract_i8(value: i8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i8, i.e. it is greater than 8.

pub const fn extract_u8(value: u8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u8, i.e. it is greater than 8.

pub const fn extract_i16(value: i16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i16, i.e. it is greater than 16.

pub const fn extract_u16(value: u16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u16, i.e. it is greater than 16.

pub const fn extract_i32(value: i32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i32, i.e. it is greater than 32.

pub const fn extract_u32(value: u32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u32, i.e. it is greater than 32.

pub const fn extract_i64(value: i64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i64, i.e. it is greater than 64.

pub const fn extract_u64(value: u64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u64, i.e. it is greater than 64.

pub const fn extract_i128(value: i128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i128, i.e. it is greater than 128.

pub const fn extract_u128(value: u128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u128, i.e. it is greater than 128.

pub const fn widen<const BITS_RESULT: usize>(self) -> Int<i16, BITS_RESULT>

Returns an Int with a wider bit depth but with the same base data type

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_add(i14::new(27)), i14::new(127));
assert_eq!(i14::MAX.wrapping_add(i14::new(2)), i14::MIN + i14::new(1));

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(0).wrapping_sub(i14::new(127)), i14::new(-127));
assert_eq!(i14::new(-2).wrapping_sub(i14::MAX), i14::MAX);

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(10).wrapping_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::new(12).wrapping_mul(i14::new(1024)), i14::new(-4096));

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

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_div(i14::new(10)), i14::new(10));
assert_eq!(i14::MIN.wrapping_div(i14::new(-1)), i14::MIN);

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_neg(), i14::new(-100));
assert_eq!(i14::new(-100).wrapping_neg(), i14::new(100));
assert_eq!(i14::MIN.wrapping_neg(), i14::MIN);

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

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_left function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-1).wrapping_shl(7), i14::new(-128));
assert_eq!(i14::new(-1).wrapping_shl(128), i14::new(-4));

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

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_right function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-128).wrapping_shr(7), i14::new(-1));
assert_eq!(i14::new(-128).wrapping_shr(60), i14::new(-8));

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_add(i14::new(1)), i14::new(101));
assert_eq!(i14::MAX.saturating_add(i14::new(100)), i14::MAX);
assert_eq!(i14::MIN.saturating_add(i14::new(-1)), i14::MIN);

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_sub(i14::new(127)), i14::new(-27));
assert_eq!(i14::MIN.saturating_sub(i14::new(100)), i14::MIN);
assert_eq!(i14::MAX.saturating_sub(i14::new(-1)), i14::MAX);

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(10).saturating_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::MAX.saturating_mul(i14::new(10)), i14::MAX);
assert_eq!(i14::MIN.saturating_mul(i14::new(10)), i14::MIN);

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).saturating_div(i14::new(2)), i14::new(2));
assert_eq!(i14::MAX.saturating_div(i14::new(-1)), i14::MIN + i14::new(1));
assert_eq!(i14::MIN.saturating_div(i14::new(-1)), i14::MAX);

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_neg(), i14::new(-100));
assert_eq!(i14::new(-100).saturating_neg(), i14::new(100));
assert_eq!(i14::MIN.saturating_neg(), i14::MAX);
assert_eq!(i14::MAX.saturating_neg(), i14::MIN + i14::new(1));

pub const fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(-4).saturating_pow(3), i14::new(-64));
assert_eq!(i14::MIN.saturating_pow(2), i14::MAX);
assert_eq!(i14::MIN.saturating_pow(3), i14::MIN);

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(1)), Some(i14::MAX - i14::new(1)));
assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(3)), None);

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(1)), Some(i14::MIN + i14::new(1)));
assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(3)), None);

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(i14::MAX.checked_mul(i14::new(1)), Some(i14::MAX));
assert_eq!(i14::MAX.checked_mul(i14::new(2)), None);

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(1)).checked_div(i14::new(-1)), Some(i14::new(8191)));
assert_eq!(i14::MIN.checked_div(i14::new(-1)), None);
assert_eq!((i14::new(1)).checked_div(i14::new(0)), None);

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

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

Examples

Basic usage:

assert_eq!(i14::new(5).checked_neg(), Some(i14::new(-5)));
assert_eq!(i14::MIN.checked_neg(), None);

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

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x1).checked_shl(4), Some(i14::new(0x10)));
assert_eq!(i14::new(0x1).checked_shl(129), None);
assert_eq!(i14::new(0x10).checked_shl(13), Some(i14::new(0)));

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

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x10).checked_shr(4), Some(i14::new(0x1)));
assert_eq!(i14::new(0x10).checked_shr(129), None);

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

Calculates self + rhs.

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_add(i14::new(2)), (i14::new(7), false));
assert_eq!(i14::MAX.overflowing_add(i14::new(1)), (i14::MIN, true));

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

Calculates self - rhs.

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_sub(i14::new(2)), (i14::new(3), false));
assert_eq!(i14::MIN.overflowing_sub(i14::new(1)), (i14::MAX, true));

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_mul(i14::new(2)), (i14::new(10), false));
assert_eq!(i14::new(1_000).overflowing_mul(i14::new(10)), (i14::new(-6384), true));

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_div(i14::new(2)), (i14::new(2), false));
assert_eq!(i14::MIN.overflowing_div(i14::new(-1)), (i14::MIN, true));

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i14::MIN for values of type i14), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(i14::new(2).overflowing_neg(), (i14::new(-2), false));
assert_eq!(i14::MIN.overflowing_neg(), (i14::MIN, true));

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x1).overflowing_shl(4), (i14::new(0x10), false));
assert_eq!(i14::new(0x1).overflowing_shl(15), (i14::new(0x2), true));
assert_eq!(i14::new(0x10).overflowing_shl(13), (i14::new(0), false));

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x10).overflowing_shr(4), (i14::new(0x1), false));
assert_eq!(i14::new(0x10).overflowing_shr(15), (i14::new(0x8), true));

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(i14::new(10).is_positive());
assert!(!i14::new(-10).is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(i14::new(-10).is_negative());
assert!(!i14::new(10).is_negative());

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

Examples

Basic usage:

assert_eq!(i6::from_bits(0b10_1010).reverse_bits(), i6::from_bits(0b01_0101));
assert_eq!(i6::new(0), i6::new(0).reverse_bits());

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::from_bits(0b00_1000);
assert_eq!(n.count_ones(), 1);

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

assert_eq!(i6::MAX.count_zeros(), 1);

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_ones(), 6);

pub const fn leading_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(3);
assert_eq!(n.trailing_ones(), 2);

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-4);
assert_eq!(n.trailing_zeros(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_left(1), m);

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_right(1), m);

impl<const BITS: usize> Int<i32, BITS>

pub const MASK: i32

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

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i8(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i16(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i32(value: i32) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i64(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i128(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn try_new(value: i32) -> Result<Self, TryNewError>

Creates an instance or an error if the given value is outside of the valid range

pub const fn to_bits(self) -> u32

Returns the bitwise representation of the value.

As the bit width is limited to BITS the numeric value may differ from value.

let value = i3::new(-1);
assert_eq!(value.to_bits(), 0b111); // 7
assert_eq!(value.value(), -1);

To convert from the bitwise representation back to an instance, use from_bits.

pub const fn from_bits(value: u32) -> Self

Convert the bitwise representation from to_bits to an instance.

let value = i3::from_bits(0b111);
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use new.

Panics

Panics if the given value exceeds the bit width specified by BITS.

pub const fn try_from_bits(value: u32) -> Result<Self, TryNewError>

Tries to convert the bitwise representation from to_bits to an instance.

i3::try_from_bits(0b1111).expect_err("value is > 3 bits");
let value = i3::try_from_bits(0b111).expect("value is <= 3 bits");
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use try_new.

Errors

Returns an error if the given value exceeds the bit width specified by BITS.

pub const unsafe fn from_bits_unchecked(value: u32) -> Self

Converts the bitwise representation from to_bits to an instance, without checking the bounds.

Safety

The given value must not exceed the bit width specified by Self::BITS.

pub const fn extract_i8(value: i8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i8, i.e. it is greater than 8.

pub const fn extract_u8(value: u8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u8, i.e. it is greater than 8.

pub const fn extract_i16(value: i16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i16, i.e. it is greater than 16.

pub const fn extract_u16(value: u16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u16, i.e. it is greater than 16.

pub const fn extract_i32(value: i32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i32, i.e. it is greater than 32.

pub const fn extract_u32(value: u32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u32, i.e. it is greater than 32.

pub const fn extract_i64(value: i64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i64, i.e. it is greater than 64.

pub const fn extract_u64(value: u64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u64, i.e. it is greater than 64.

pub const fn extract_i128(value: i128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i128, i.e. it is greater than 128.

pub const fn extract_u128(value: u128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u128, i.e. it is greater than 128.

pub const fn widen<const BITS_RESULT: usize>(self) -> Int<i32, BITS_RESULT>

Returns an Int with a wider bit depth but with the same base data type

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_add(i14::new(27)), i14::new(127));
assert_eq!(i14::MAX.wrapping_add(i14::new(2)), i14::MIN + i14::new(1));

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(0).wrapping_sub(i14::new(127)), i14::new(-127));
assert_eq!(i14::new(-2).wrapping_sub(i14::MAX), i14::MAX);

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(10).wrapping_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::new(12).wrapping_mul(i14::new(1024)), i14::new(-4096));

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

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_div(i14::new(10)), i14::new(10));
assert_eq!(i14::MIN.wrapping_div(i14::new(-1)), i14::MIN);

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_neg(), i14::new(-100));
assert_eq!(i14::new(-100).wrapping_neg(), i14::new(100));
assert_eq!(i14::MIN.wrapping_neg(), i14::MIN);

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

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_left function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-1).wrapping_shl(7), i14::new(-128));
assert_eq!(i14::new(-1).wrapping_shl(128), i14::new(-4));

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

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_right function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-128).wrapping_shr(7), i14::new(-1));
assert_eq!(i14::new(-128).wrapping_shr(60), i14::new(-8));

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_add(i14::new(1)), i14::new(101));
assert_eq!(i14::MAX.saturating_add(i14::new(100)), i14::MAX);
assert_eq!(i14::MIN.saturating_add(i14::new(-1)), i14::MIN);

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_sub(i14::new(127)), i14::new(-27));
assert_eq!(i14::MIN.saturating_sub(i14::new(100)), i14::MIN);
assert_eq!(i14::MAX.saturating_sub(i14::new(-1)), i14::MAX);

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(10).saturating_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::MAX.saturating_mul(i14::new(10)), i14::MAX);
assert_eq!(i14::MIN.saturating_mul(i14::new(10)), i14::MIN);

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).saturating_div(i14::new(2)), i14::new(2));
assert_eq!(i14::MAX.saturating_div(i14::new(-1)), i14::MIN + i14::new(1));
assert_eq!(i14::MIN.saturating_div(i14::new(-1)), i14::MAX);

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_neg(), i14::new(-100));
assert_eq!(i14::new(-100).saturating_neg(), i14::new(100));
assert_eq!(i14::MIN.saturating_neg(), i14::MAX);
assert_eq!(i14::MAX.saturating_neg(), i14::MIN + i14::new(1));

pub const fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(-4).saturating_pow(3), i14::new(-64));
assert_eq!(i14::MIN.saturating_pow(2), i14::MAX);
assert_eq!(i14::MIN.saturating_pow(3), i14::MIN);

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(1)), Some(i14::MAX - i14::new(1)));
assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(3)), None);

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(1)), Some(i14::MIN + i14::new(1)));
assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(3)), None);

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(i14::MAX.checked_mul(i14::new(1)), Some(i14::MAX));
assert_eq!(i14::MAX.checked_mul(i14::new(2)), None);

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(1)).checked_div(i14::new(-1)), Some(i14::new(8191)));
assert_eq!(i14::MIN.checked_div(i14::new(-1)), None);
assert_eq!((i14::new(1)).checked_div(i14::new(0)), None);

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

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

Examples

Basic usage:

assert_eq!(i14::new(5).checked_neg(), Some(i14::new(-5)));
assert_eq!(i14::MIN.checked_neg(), None);

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

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x1).checked_shl(4), Some(i14::new(0x10)));
assert_eq!(i14::new(0x1).checked_shl(129), None);
assert_eq!(i14::new(0x10).checked_shl(13), Some(i14::new(0)));

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

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x10).checked_shr(4), Some(i14::new(0x1)));
assert_eq!(i14::new(0x10).checked_shr(129), None);

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

Calculates self + rhs.

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_add(i14::new(2)), (i14::new(7), false));
assert_eq!(i14::MAX.overflowing_add(i14::new(1)), (i14::MIN, true));

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

Calculates self - rhs.

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_sub(i14::new(2)), (i14::new(3), false));
assert_eq!(i14::MIN.overflowing_sub(i14::new(1)), (i14::MAX, true));

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_mul(i14::new(2)), (i14::new(10), false));
assert_eq!(i14::new(1_000).overflowing_mul(i14::new(10)), (i14::new(-6384), true));

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_div(i14::new(2)), (i14::new(2), false));
assert_eq!(i14::MIN.overflowing_div(i14::new(-1)), (i14::MIN, true));

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i14::MIN for values of type i14), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(i14::new(2).overflowing_neg(), (i14::new(-2), false));
assert_eq!(i14::MIN.overflowing_neg(), (i14::MIN, true));

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x1).overflowing_shl(4), (i14::new(0x10), false));
assert_eq!(i14::new(0x1).overflowing_shl(15), (i14::new(0x2), true));
assert_eq!(i14::new(0x10).overflowing_shl(13), (i14::new(0), false));

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x10).overflowing_shr(4), (i14::new(0x1), false));
assert_eq!(i14::new(0x10).overflowing_shr(15), (i14::new(0x8), true));

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(i14::new(10).is_positive());
assert!(!i14::new(-10).is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(i14::new(-10).is_negative());
assert!(!i14::new(10).is_negative());

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

Examples

Basic usage:

assert_eq!(i6::from_bits(0b10_1010).reverse_bits(), i6::from_bits(0b01_0101));
assert_eq!(i6::new(0), i6::new(0).reverse_bits());

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::from_bits(0b00_1000);
assert_eq!(n.count_ones(), 1);

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

assert_eq!(i6::MAX.count_zeros(), 1);

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_ones(), 6);

pub const fn leading_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(3);
assert_eq!(n.trailing_ones(), 2);

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-4);
assert_eq!(n.trailing_zeros(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_left(1), m);

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_right(1), m);

impl<const BITS: usize> Int<i64, BITS>

pub const MASK: i64

pub const fn new(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i8(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i16(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i32(value: i32) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i64(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i128(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn try_new(value: i64) -> Result<Self, TryNewError>

Creates an instance or an error if the given value is outside of the valid range

pub const fn to_bits(self) -> u64

Returns the bitwise representation of the value.

As the bit width is limited to BITS the numeric value may differ from value.

let value = i3::new(-1);
assert_eq!(value.to_bits(), 0b111); // 7
assert_eq!(value.value(), -1);

To convert from the bitwise representation back to an instance, use from_bits.

pub const fn from_bits(value: u64) -> Self

Convert the bitwise representation from to_bits to an instance.

let value = i3::from_bits(0b111);
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use new.

Panics

Panics if the given value exceeds the bit width specified by BITS.

pub const fn try_from_bits(value: u64) -> Result<Self, TryNewError>

Tries to convert the bitwise representation from to_bits to an instance.

i3::try_from_bits(0b1111).expect_err("value is > 3 bits");
let value = i3::try_from_bits(0b111).expect("value is <= 3 bits");
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use try_new.

Errors

Returns an error if the given value exceeds the bit width specified by BITS.

pub const unsafe fn from_bits_unchecked(value: u64) -> Self

Converts the bitwise representation from to_bits to an instance, without checking the bounds.

Safety

The given value must not exceed the bit width specified by Self::BITS.

pub const fn extract_i8(value: i8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i8, i.e. it is greater than 8.

pub const fn extract_u8(value: u8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u8, i.e. it is greater than 8.

pub const fn extract_i16(value: i16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i16, i.e. it is greater than 16.

pub const fn extract_u16(value: u16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u16, i.e. it is greater than 16.

pub const fn extract_i32(value: i32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i32, i.e. it is greater than 32.

pub const fn extract_u32(value: u32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u32, i.e. it is greater than 32.

pub const fn extract_i64(value: i64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i64, i.e. it is greater than 64.

pub const fn extract_u64(value: u64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u64, i.e. it is greater than 64.

pub const fn extract_i128(value: i128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i128, i.e. it is greater than 128.

pub const fn extract_u128(value: u128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u128, i.e. it is greater than 128.

pub const fn widen<const BITS_RESULT: usize>(self) -> Int<i64, BITS_RESULT>

Returns an Int with a wider bit depth but with the same base data type

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_add(i14::new(27)), i14::new(127));
assert_eq!(i14::MAX.wrapping_add(i14::new(2)), i14::MIN + i14::new(1));

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(0).wrapping_sub(i14::new(127)), i14::new(-127));
assert_eq!(i14::new(-2).wrapping_sub(i14::MAX), i14::MAX);

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(10).wrapping_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::new(12).wrapping_mul(i14::new(1024)), i14::new(-4096));

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

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_div(i14::new(10)), i14::new(10));
assert_eq!(i14::MIN.wrapping_div(i14::new(-1)), i14::MIN);

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_neg(), i14::new(-100));
assert_eq!(i14::new(-100).wrapping_neg(), i14::new(100));
assert_eq!(i14::MIN.wrapping_neg(), i14::MIN);

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

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_left function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-1).wrapping_shl(7), i14::new(-128));
assert_eq!(i14::new(-1).wrapping_shl(128), i14::new(-4));

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

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_right function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-128).wrapping_shr(7), i14::new(-1));
assert_eq!(i14::new(-128).wrapping_shr(60), i14::new(-8));

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_add(i14::new(1)), i14::new(101));
assert_eq!(i14::MAX.saturating_add(i14::new(100)), i14::MAX);
assert_eq!(i14::MIN.saturating_add(i14::new(-1)), i14::MIN);

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_sub(i14::new(127)), i14::new(-27));
assert_eq!(i14::MIN.saturating_sub(i14::new(100)), i14::MIN);
assert_eq!(i14::MAX.saturating_sub(i14::new(-1)), i14::MAX);

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(10).saturating_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::MAX.saturating_mul(i14::new(10)), i14::MAX);
assert_eq!(i14::MIN.saturating_mul(i14::new(10)), i14::MIN);

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).saturating_div(i14::new(2)), i14::new(2));
assert_eq!(i14::MAX.saturating_div(i14::new(-1)), i14::MIN + i14::new(1));
assert_eq!(i14::MIN.saturating_div(i14::new(-1)), i14::MAX);

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_neg(), i14::new(-100));
assert_eq!(i14::new(-100).saturating_neg(), i14::new(100));
assert_eq!(i14::MIN.saturating_neg(), i14::MAX);
assert_eq!(i14::MAX.saturating_neg(), i14::MIN + i14::new(1));

pub const fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(-4).saturating_pow(3), i14::new(-64));
assert_eq!(i14::MIN.saturating_pow(2), i14::MAX);
assert_eq!(i14::MIN.saturating_pow(3), i14::MIN);

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(1)), Some(i14::MAX - i14::new(1)));
assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(3)), None);

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(1)), Some(i14::MIN + i14::new(1)));
assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(3)), None);

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(i14::MAX.checked_mul(i14::new(1)), Some(i14::MAX));
assert_eq!(i14::MAX.checked_mul(i14::new(2)), None);

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(1)).checked_div(i14::new(-1)), Some(i14::new(8191)));
assert_eq!(i14::MIN.checked_div(i14::new(-1)), None);
assert_eq!((i14::new(1)).checked_div(i14::new(0)), None);

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

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

Examples

Basic usage:

assert_eq!(i14::new(5).checked_neg(), Some(i14::new(-5)));
assert_eq!(i14::MIN.checked_neg(), None);

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

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x1).checked_shl(4), Some(i14::new(0x10)));
assert_eq!(i14::new(0x1).checked_shl(129), None);
assert_eq!(i14::new(0x10).checked_shl(13), Some(i14::new(0)));

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

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x10).checked_shr(4), Some(i14::new(0x1)));
assert_eq!(i14::new(0x10).checked_shr(129), None);

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

Calculates self + rhs.

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_add(i14::new(2)), (i14::new(7), false));
assert_eq!(i14::MAX.overflowing_add(i14::new(1)), (i14::MIN, true));

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

Calculates self - rhs.

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_sub(i14::new(2)), (i14::new(3), false));
assert_eq!(i14::MIN.overflowing_sub(i14::new(1)), (i14::MAX, true));

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_mul(i14::new(2)), (i14::new(10), false));
assert_eq!(i14::new(1_000).overflowing_mul(i14::new(10)), (i14::new(-6384), true));

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_div(i14::new(2)), (i14::new(2), false));
assert_eq!(i14::MIN.overflowing_div(i14::new(-1)), (i14::MIN, true));

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i14::MIN for values of type i14), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(i14::new(2).overflowing_neg(), (i14::new(-2), false));
assert_eq!(i14::MIN.overflowing_neg(), (i14::MIN, true));

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x1).overflowing_shl(4), (i14::new(0x10), false));
assert_eq!(i14::new(0x1).overflowing_shl(15), (i14::new(0x2), true));
assert_eq!(i14::new(0x10).overflowing_shl(13), (i14::new(0), false));

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x10).overflowing_shr(4), (i14::new(0x1), false));
assert_eq!(i14::new(0x10).overflowing_shr(15), (i14::new(0x8), true));

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(i14::new(10).is_positive());
assert!(!i14::new(-10).is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(i14::new(-10).is_negative());
assert!(!i14::new(10).is_negative());

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

Examples

Basic usage:

assert_eq!(i6::from_bits(0b10_1010).reverse_bits(), i6::from_bits(0b01_0101));
assert_eq!(i6::new(0), i6::new(0).reverse_bits());

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::from_bits(0b00_1000);
assert_eq!(n.count_ones(), 1);

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

assert_eq!(i6::MAX.count_zeros(), 1);

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_ones(), 6);

pub const fn leading_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(3);
assert_eq!(n.trailing_ones(), 2);

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-4);
assert_eq!(n.trailing_zeros(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_left(1), m);

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_right(1), m);

impl<const BITS: usize> Int<i128, BITS>

pub const MASK: i128

pub const fn new(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i8(value: i8) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i16(value: i16) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i32(value: i32) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i64(value: i64) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn from_i128(value: i128) -> Self

Creates an instance. Panics if the given value is outside of the valid range

pub const fn try_new(value: i128) -> Result<Self, TryNewError>

Creates an instance or an error if the given value is outside of the valid range

pub const fn to_bits(self) -> u128

Returns the bitwise representation of the value.

As the bit width is limited to BITS the numeric value may differ from value.

let value = i3::new(-1);
assert_eq!(value.to_bits(), 0b111); // 7
assert_eq!(value.value(), -1);

To convert from the bitwise representation back to an instance, use from_bits.

pub const fn from_bits(value: u128) -> Self

Convert the bitwise representation from to_bits to an instance.

let value = i3::from_bits(0b111);
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use new.

Panics

Panics if the given value exceeds the bit width specified by BITS.

pub const fn try_from_bits(value: u128) -> Result<Self, TryNewError>

Tries to convert the bitwise representation from to_bits to an instance.

i3::try_from_bits(0b1111).expect_err("value is > 3 bits");
let value = i3::try_from_bits(0b111).expect("value is <= 3 bits");
assert_eq!(value.value(), -1);
assert_eq!(value.to_bits(), 0b111);

If you want to convert a numeric value to an instance instead, use try_new.

Errors

Returns an error if the given value exceeds the bit width specified by BITS.

pub const unsafe fn from_bits_unchecked(value: u128) -> Self

Converts the bitwise representation from to_bits to an instance, without checking the bounds.

Safety

The given value must not exceed the bit width specified by Self::BITS.

pub const fn extract_i8(value: i8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i8, i.e. it is greater than 8.

pub const fn extract_u8(value: u8, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u8, i.e. it is greater than 8.

pub const fn extract_i16(value: i16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i16, i.e. it is greater than 16.

pub const fn extract_u16(value: u16, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u16, i.e. it is greater than 16.

pub const fn extract_i32(value: i32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i32, i.e. it is greater than 32.

pub const fn extract_u32(value: u32, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u32, i.e. it is greater than 32.

pub const fn extract_i64(value: i64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i64, i.e. it is greater than 64.

pub const fn extract_u64(value: u64, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u64, i.e. it is greater than 64.

pub const fn extract_i128(value: i128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an i128, i.e. it is greater than 128.

pub const fn extract_u128(value: u128, start_bit: usize) -> Self

Extracts bits from a given value, starting from start_bit. This is equivalent to: from_bits(value >> start_bit). Unlike new, this function doesn’t perform range-checking and is slightly more efficient.

Panics

Panics if start_bit + Self::BITS doesn’t fit within an u128, i.e. it is greater than 128.

pub const fn widen<const BITS_RESULT: usize>(self) -> Int<i128, BITS_RESULT>

Returns an Int with a wider bit depth but with the same base data type

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

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_add(i14::new(27)), i14::new(127));
assert_eq!(i14::MAX.wrapping_add(i14::new(2)), i14::MIN + i14::new(1));

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

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(0).wrapping_sub(i14::new(127)), i14::new(-127));
assert_eq!(i14::new(-2).wrapping_sub(i14::MAX), i14::MAX);

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

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

Examples

Basic usage:

assert_eq!(i14::new(10).wrapping_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::new(12).wrapping_mul(i14::new(1024)), i14::new(-4096));

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

Wrapping (modular) division. Computes self / rhs, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one divides MIN / -1 on a signed type (where MIN is the negative minimal value for the type); this is equivalent to -MIN, a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_div(i14::new(10)), i14::new(10));
assert_eq!(i14::MIN.wrapping_div(i14::new(-1)), i14::MIN);

pub const fn wrapping_neg(self) -> Self

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

Examples

Basic usage:

assert_eq!(i14::new(100).wrapping_neg(), i14::new(-100));
assert_eq!(i14::new(-100).wrapping_neg(), i14::new(100));
assert_eq!(i14::MIN.wrapping_neg(), i14::MIN);

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

Panic-free bitwise shift-left; yields self << mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-left; the RHS of a wrapping shift-left is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_left function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-1).wrapping_shl(7), i14::new(-128));
assert_eq!(i14::new(-1).wrapping_shl(128), i14::new(-4));

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

Panic-free bitwise shift-right; yields self >> mask(rhs), where mask removes any high-order bits of rhs that would cause the shift to exceed the bitwidth of the type.

Note that this is not the same as a rotate-right; the RHS of a wrapping shift-right is restricted to the range of the type, rather than the bits shifted out of the LHS being returned to the other end. A rotate_right function exists as well, which may be what you want instead.

Examples

Basic usage:

assert_eq!(i14::new(-128).wrapping_shr(7), i14::new(-1));
assert_eq!(i14::new(-128).wrapping_shr(60), i14::new(-8));

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

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_add(i14::new(1)), i14::new(101));
assert_eq!(i14::MAX.saturating_add(i14::new(100)), i14::MAX);
assert_eq!(i14::MIN.saturating_add(i14::new(-1)), i14::MIN);

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

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_sub(i14::new(127)), i14::new(-27));
assert_eq!(i14::MIN.saturating_sub(i14::new(100)), i14::MIN);
assert_eq!(i14::MAX.saturating_sub(i14::new(-1)), i14::MAX);

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

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(10).saturating_mul(i14::new(12)), i14::new(120));
assert_eq!(i14::MAX.saturating_mul(i14::new(10)), i14::MAX);
assert_eq!(i14::MIN.saturating_mul(i14::new(10)), i14::MIN);

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

Saturating integer division. Computes self / rhs, saturating at the numeric bounds instead of overflowing.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).saturating_div(i14::new(2)), i14::new(2));
assert_eq!(i14::MAX.saturating_div(i14::new(-1)), i14::MIN + i14::new(1));
assert_eq!(i14::MIN.saturating_div(i14::new(-1)), i14::MAX);

pub const fn saturating_neg(self) -> Self

Saturating integer negation. Computes -self, returning MAX if self == MIN instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(100).saturating_neg(), i14::new(-100));
assert_eq!(i14::new(-100).saturating_neg(), i14::new(100));
assert_eq!(i14::MIN.saturating_neg(), i14::MAX);
assert_eq!(i14::MAX.saturating_neg(), i14::MIN + i14::new(1));

pub const fn saturating_pow(self, exp: u32) -> Self

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

Examples

Basic usage:

assert_eq!(i14::new(-4).saturating_pow(3), i14::new(-64));
assert_eq!(i14::MIN.saturating_pow(2), i14::MAX);
assert_eq!(i14::MIN.saturating_pow(3), i14::MIN);

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

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(1)), Some(i14::MAX - i14::new(1)));
assert_eq!((i14::MAX - i14::new(2)).checked_add(i14::new(3)), None);

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

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(1)), Some(i14::MIN + i14::new(1)));
assert_eq!((i14::MIN + i14::new(2)).checked_sub(i14::new(3)), None);

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

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

Examples

Basic usage:

assert_eq!(i14::MAX.checked_mul(i14::new(1)), Some(i14::MAX));
assert_eq!(i14::MAX.checked_mul(i14::new(2)), None);

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

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Examples

Basic usage:

assert_eq!((i14::MIN + i14::new(1)).checked_div(i14::new(-1)), Some(i14::new(8191)));
assert_eq!(i14::MIN.checked_div(i14::new(-1)), None);
assert_eq!((i14::new(1)).checked_div(i14::new(0)), None);

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

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

Examples

Basic usage:

assert_eq!(i14::new(5).checked_neg(), Some(i14::new(-5)));
assert_eq!(i14::MIN.checked_neg(), None);

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

Checked shift left. Computes self << rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x1).checked_shl(4), Some(i14::new(0x10)));
assert_eq!(i14::new(0x1).checked_shl(129), None);
assert_eq!(i14::new(0x10).checked_shl(13), Some(i14::new(0)));

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

Checked shift right. Computes self >> rhs, returning None if rhs is larger than or equal to the number of bits in self.

Examples

Basic usage:

assert_eq!(i14::new(0x10).checked_shr(4), Some(i14::new(0x1)));
assert_eq!(i14::new(0x10).checked_shr(129), None);

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

Calculates self + rhs.

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_add(i14::new(2)), (i14::new(7), false));
assert_eq!(i14::MAX.overflowing_add(i14::new(1)), (i14::MIN, true));

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

Calculates self - rhs.

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_sub(i14::new(2)), (i14::new(3), false));
assert_eq!(i14::MIN.overflowing_sub(i14::new(1)), (i14::MAX, true));

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

Calculates the multiplication of self and rhs.

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_mul(i14::new(2)), (i14::new(10), false));
assert_eq!(i14::new(1_000).overflowing_mul(i14::new(10)), (i14::new(-6384), true));

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

Calculates the divisor when self is divided by rhs.

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Panics

This function will panic if rhs is zero.

Examples

Basic usage:

assert_eq!(i14::new(5).overflowing_div(i14::new(2)), (i14::new(2), false));
assert_eq!(i14::MIN.overflowing_div(i14::new(-1)), (i14::MIN, true));

pub const fn overflowing_neg(self) -> (Self, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value (e.g., i14::MIN for values of type i14), then the minimum value will be returned again and true will be returned for an overflow happening.

Examples

Basic usage:

assert_eq!(i14::new(2).overflowing_neg(), (i14::new(-2), false));
assert_eq!(i14::MIN.overflowing_neg(), (i14::MIN, true));

pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool)

Shifts self left by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x1).overflowing_shl(4), (i14::new(0x10), false));
assert_eq!(i14::new(0x1).overflowing_shl(15), (i14::new(0x2), true));
assert_eq!(i14::new(0x10).overflowing_shl(13), (i14::new(0), false));

pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool)

Shifts self right by rhs bits.

Returns a tuple of the shifted version of self along with a boolean indicating whether the shift value was larger than or equal to the number of bits. If the shift value is too large, then value is masked (N-1) where N is the number of bits, and this value is then used to perform the shift.

Examples

Basic usage:

assert_eq!(i14::new(0x10).overflowing_shr(4), (i14::new(0x1), false));
assert_eq!(i14::new(0x10).overflowing_shr(15), (i14::new(0x8), true));

pub const fn is_positive(self) -> bool

Returns true if self is positive and false if the number is zero or negative.

Examples

Basic usage:

assert!(i14::new(10).is_positive());
assert!(!i14::new(-10).is_positive());

pub const fn is_negative(self) -> bool

Returns true if self is negative and false if the number is zero or positive.

Examples

Basic usage:

assert!(i14::new(-10).is_negative());
assert!(!i14::new(10).is_negative());

pub const fn reverse_bits(self) -> Self

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

Examples

Basic usage:

assert_eq!(i6::from_bits(0b10_1010).reverse_bits(), i6::from_bits(0b01_0101));
assert_eq!(i6::new(0), i6::new(0).reverse_bits());

pub const fn count_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::from_bits(0b00_1000);
assert_eq!(n.count_ones(), 1);

pub const fn count_zeros(self) -> u32

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

Examples

Basic usage:

assert_eq!(i6::MAX.count_zeros(), 1);

pub const fn leading_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_ones(), 6);

pub const fn leading_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-1);
assert_eq!(n.leading_zeros(), 0);

pub const fn trailing_ones(self) -> u32

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

Examples

Basic usage:

let n = i6::new(3);
assert_eq!(n.trailing_ones(), 2);

pub const fn trailing_zeros(self) -> u32

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

Examples

Basic usage:

let n = i6::new(-4);
assert_eq!(n.trailing_zeros(), 2);

pub const fn rotate_left(self, n: u32) -> Self

Shifts the bits to the left by a specified amount, n, wrapping the truncated bits to the end of the resulting integer.

Please note this isn’t the same operation as the << shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_left(1), m);

pub const fn rotate_right(self, n: u32) -> Self

Shifts the bits to the right by a specified amount, n, wrapping the truncated bits to the beginning of the resulting integer.

Please note this isn’t the same operation as the >> shifting operator!

Examples

Basic usage:

let n = i6::from_bits(0b10_1010);
let m = i6::from_bits(0b01_0101);

assert_eq!(n.rotate_right(1), m);

impl Int<i32, 24>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 3]

pub const fn to_be_bytes(self) -> [u8; 3]

pub const fn from_le_bytes(from: [u8; 3]) -> Self

pub const fn from_be_bytes(from: [u8; 3]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 3]

pub const fn from_ne_bytes(bytes: [u8; 3]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i64, 24>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 3]

pub const fn to_be_bytes(self) -> [u8; 3]

pub const fn from_le_bytes(from: [u8; 3]) -> Self

pub const fn from_be_bytes(from: [u8; 3]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 3]

pub const fn from_ne_bytes(bytes: [u8; 3]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 24>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 3]

pub const fn to_be_bytes(self) -> [u8; 3]

pub const fn from_le_bytes(from: [u8; 3]) -> Self

pub const fn from_be_bytes(from: [u8; 3]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 3]

pub const fn from_ne_bytes(bytes: [u8; 3]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i64, 40>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 5]

pub const fn to_be_bytes(self) -> [u8; 5]

pub const fn from_le_bytes(from: [u8; 5]) -> Self

pub const fn from_be_bytes(from: [u8; 5]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 5]

pub const fn from_ne_bytes(bytes: [u8; 5]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 40>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 5]

pub const fn to_be_bytes(self) -> [u8; 5]

pub const fn from_le_bytes(from: [u8; 5]) -> Self

pub const fn from_be_bytes(from: [u8; 5]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 5]

pub const fn from_ne_bytes(bytes: [u8; 5]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i64, 48>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 6]

pub const fn to_be_bytes(self) -> [u8; 6]

pub const fn from_le_bytes(from: [u8; 6]) -> Self

pub const fn from_be_bytes(from: [u8; 6]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 6]

pub const fn from_ne_bytes(bytes: [u8; 6]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 48>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 6]

pub const fn to_be_bytes(self) -> [u8; 6]

pub const fn from_le_bytes(from: [u8; 6]) -> Self

pub const fn from_be_bytes(from: [u8; 6]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 6]

pub const fn from_ne_bytes(bytes: [u8; 6]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i64, 56>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 7]

pub const fn to_be_bytes(self) -> [u8; 7]

pub const fn from_le_bytes(from: [u8; 7]) -> Self

pub const fn from_be_bytes(from: [u8; 7]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 7]

pub const fn from_ne_bytes(bytes: [u8; 7]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 56>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 7]

pub const fn to_be_bytes(self) -> [u8; 7]

pub const fn from_le_bytes(from: [u8; 7]) -> Self

pub const fn from_be_bytes(from: [u8; 7]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 7]

pub const fn from_ne_bytes(bytes: [u8; 7]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 72>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 9]

pub const fn to_be_bytes(self) -> [u8; 9]

pub const fn from_le_bytes(from: [u8; 9]) -> Self

pub const fn from_be_bytes(from: [u8; 9]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 9]

pub const fn from_ne_bytes(bytes: [u8; 9]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 80>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 10]

pub const fn to_be_bytes(self) -> [u8; 10]

pub const fn from_le_bytes(from: [u8; 10]) -> Self

pub const fn from_be_bytes(from: [u8; 10]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 10]

pub const fn from_ne_bytes(bytes: [u8; 10]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 88>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 11]

pub const fn to_be_bytes(self) -> [u8; 11]

pub const fn from_le_bytes(from: [u8; 11]) -> Self

pub const fn from_be_bytes(from: [u8; 11]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 11]

pub const fn from_ne_bytes(bytes: [u8; 11]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 96>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 12]

pub const fn to_be_bytes(self) -> [u8; 12]

pub const fn from_le_bytes(from: [u8; 12]) -> Self

pub const fn from_be_bytes(from: [u8; 12]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 12]

pub const fn from_ne_bytes(bytes: [u8; 12]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 104>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 13]

pub const fn to_be_bytes(self) -> [u8; 13]

pub const fn from_le_bytes(from: [u8; 13]) -> Self

pub const fn from_be_bytes(from: [u8; 13]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 13]

pub const fn from_ne_bytes(bytes: [u8; 13]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 112>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 14]

pub const fn to_be_bytes(self) -> [u8; 14]

pub const fn from_le_bytes(from: [u8; 14]) -> Self

pub const fn from_be_bytes(from: [u8; 14]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 14]

pub const fn from_ne_bytes(bytes: [u8; 14]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

impl Int<i128, 120>

pub const fn swap_bytes(self) -> Self

Reverses the byte order of the integer.

pub const fn to_le_bytes(self) -> [u8; 15]

pub const fn to_be_bytes(self) -> [u8; 15]

pub const fn from_le_bytes(from: [u8; 15]) -> Self

pub const fn from_be_bytes(from: [u8; 15]) -> Self

pub const fn to_ne_bytes(self) -> [u8; 15]

pub const fn from_ne_bytes(bytes: [u8; 15]) -> Self

pub const fn to_le(self) -> Self

pub const fn to_be(self) -> Self

pub const fn from_le(value: Self) -> Self

pub const fn from_be(value: Self) -> Self

Trait Implementations

impl<T, const BITS: usize> Add for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

type Output = Int<T, BITS>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, const BITS: usize> AddAssign for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Binary for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitAnd for Int<T, BITS>

type Output = Int<T, BITS>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitAndAssign for Int<T, BITS>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitOr for Int<T, BITS>

type Output = Int<T, BITS>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitOrAssign for Int<T, BITS>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitXor for Int<T, BITS>

type Output = Int<T, BITS>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> BitXorAssign for Int<T, BITS>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<T: Clone + SignedInteger + BuiltinInteger, const BITS: usize> Clone for Int<T, BITS>

fn clone(&self) -> Int<T, BITS>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Debug for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T: Default + SignedInteger + BuiltinInteger, const BITS: usize> Default for Int<T, BITS>

fn default() -> Int<T, BITS>

Returns the “default value” for a type.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Display for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T, const BITS: usize> Div for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

type Output = Int<T, BITS>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, const BITS: usize> DivAssign for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<const BITS: usize> From<Int<i128, BITS>> for i128

fn from(from: Int<i128, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i128, BITS>> for i16

fn from(from: Int<i128, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i128, BITS>> for i32

fn from(from: Int<i128, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i128, BITS>> for i64

fn from(from: Int<i128, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i128, BITS>> for i8

fn from(from: Int<i128, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i128, BITS_FROM>> for Int<i16, BITS>

fn from(item: Int<i128, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i128, BITS_FROM>> for Int<i32, BITS>

fn from(item: Int<i128, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i128, BITS_FROM>> for Int<i64, BITS>

fn from(item: Int<i128, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i128, BITS_FROM>> for Int<i8, BITS>

fn from(item: Int<i128, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i16, BITS>> for i128

fn from(from: Int<i16, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i16, BITS>> for i16

fn from(from: Int<i16, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i16, BITS>> for i32

fn from(from: Int<i16, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i16, BITS>> for i64

fn from(from: Int<i16, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i16, BITS>> for i8

fn from(from: Int<i16, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i16, BITS_FROM>> for Int<i128, BITS>

fn from(item: Int<i16, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i16, BITS_FROM>> for Int<i32, BITS>

fn from(item: Int<i16, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i16, BITS_FROM>> for Int<i64, BITS>

fn from(item: Int<i16, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i16, BITS_FROM>> for Int<i8, BITS>

fn from(item: Int<i16, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i32, BITS>> for i128

fn from(from: Int<i32, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i32, BITS>> for i16

fn from(from: Int<i32, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i32, BITS>> for i32

fn from(from: Int<i32, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i32, BITS>> for i64

fn from(from: Int<i32, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i32, BITS>> for i8

fn from(from: Int<i32, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i32, BITS_FROM>> for Int<i128, BITS>

fn from(item: Int<i32, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i32, BITS_FROM>> for Int<i16, BITS>

fn from(item: Int<i32, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i32, BITS_FROM>> for Int<i64, BITS>

fn from(item: Int<i32, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i32, BITS_FROM>> for Int<i8, BITS>

fn from(item: Int<i32, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i64, BITS>> for i128

fn from(from: Int<i64, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i64, BITS>> for i16

fn from(from: Int<i64, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i64, BITS>> for i32

fn from(from: Int<i64, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i64, BITS>> for i64

fn from(from: Int<i64, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i64, BITS>> for i8

fn from(from: Int<i64, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i64, BITS_FROM>> for Int<i128, BITS>

fn from(item: Int<i64, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i64, BITS_FROM>> for Int<i16, BITS>

fn from(item: Int<i64, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i64, BITS_FROM>> for Int<i32, BITS>

fn from(item: Int<i64, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i64, BITS_FROM>> for Int<i8, BITS>

fn from(item: Int<i64, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i8, BITS>> for i128

fn from(from: Int<i8, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i8, BITS>> for i16

fn from(from: Int<i8, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i8, BITS>> for i32

fn from(from: Int<i8, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i8, BITS>> for i64

fn from(from: Int<i8, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<Int<i8, BITS>> for i8

fn from(from: Int<i8, BITS>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i8, BITS_FROM>> for Int<i128, BITS>

fn from(item: Int<i8, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i8, BITS_FROM>> for Int<i16, BITS>

fn from(item: Int<i8, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i8, BITS_FROM>> for Int<i32, BITS>

fn from(item: Int<i8, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize, const BITS_FROM: usize> From<Int<i8, BITS_FROM>> for Int<i64, BITS>

fn from(item: Int<i8, BITS_FROM>) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i128> for Int<i128, BITS>

fn from(from: i128) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i128> for Int<i16, BITS>

fn from(from: i128) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i128> for Int<i32, BITS>

fn from(from: i128) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i128> for Int<i64, BITS>

fn from(from: i128) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i128> for Int<i8, BITS>

fn from(from: i128) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i16> for Int<i128, BITS>

fn from(from: i16) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i16> for Int<i16, BITS>

fn from(from: i16) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i16> for Int<i32, BITS>

fn from(from: i16) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i16> for Int<i64, BITS>

fn from(from: i16) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i16> for Int<i8, BITS>

fn from(from: i16) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i32> for Int<i128, BITS>

fn from(from: i32) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i32> for Int<i16, BITS>

fn from(from: i32) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i32> for Int<i32, BITS>

fn from(from: i32) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i32> for Int<i64, BITS>

fn from(from: i32) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i32> for Int<i8, BITS>

fn from(from: i32) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i64> for Int<i128, BITS>

fn from(from: i64) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i64> for Int<i16, BITS>

fn from(from: i64) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i64> for Int<i32, BITS>

fn from(from: i64) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i64> for Int<i64, BITS>

fn from(from: i64) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i64> for Int<i8, BITS>

fn from(from: i64) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i8> for Int<i128, BITS>

fn from(from: i8) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i8> for Int<i16, BITS>

fn from(from: i8) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i8> for Int<i32, BITS>

fn from(from: i8) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i8> for Int<i64, BITS>

fn from(from: i8) -> Self

Converts to this type from the input type.

impl<const BITS: usize> From<i8> for Int<i8, BITS>

fn from(from: i8) -> Self

Converts to this type from the input type.

impl<T: Hash + SignedInteger + BuiltinInteger, const BITS: usize> Hash for Int<T, BITS>

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<const BITS: usize> Integer for Int<i128, BITS>

const BITS: usize = BITS

Number of bits that can fit in this type

const ZERO: Self

The number 0

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

type UnderlyingType = i128

type SignedInteger = Int<i128, BITS>

An equivalent type with the same number of bits but signed. If the type is already signed, this is the same type.

type UnsignedInteger = UInt<u128, BITS>

An equivalent type with the same number of bits but unsigned. If the type is already unsigned, this is the same type.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn new(value: i128) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn from_<T: Integer>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertible to T. Use Self::new for literals.

fn masked_new<T: Integer>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(self) -> u8

fn as_u16(self) -> u16

fn as_u32(self) -> u32

fn as_u64(self) -> u64

fn as_u128(self) -> u128

fn as_usize(self) -> usize

fn as_i8(self) -> i8

fn as_i16(self) -> i16

fn as_i32(self) -> i32

fn as_i64(self) -> i64

fn as_i128(self) -> i128

fn as_isize(self) -> isize

fn to_unsigned(self) -> Self::UnsignedInteger

Converts the number to its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a zero extension. Types that are already unsigned will return themselves.

fn from_unsigned(value: Self::UnsignedInteger) -> Self

Converts the number from its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a sign extension, if this type is a signed type. Types that are already unsigned will return themselves.

fn value(self) -> i128

fn as_<T: Integer>(self) -> T

impl<const BITS: usize> Integer for Int<i16, BITS>

const BITS: usize = BITS

Number of bits that can fit in this type

const ZERO: Self

The number 0

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

type UnderlyingType = i16

type SignedInteger = Int<i16, BITS>

An equivalent type with the same number of bits but signed. If the type is already signed, this is the same type.

type UnsignedInteger = UInt<u16, BITS>

An equivalent type with the same number of bits but unsigned. If the type is already unsigned, this is the same type.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn new(value: i16) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn from_<T: Integer>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertible to T. Use Self::new for literals.

fn masked_new<T: Integer>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(self) -> u8

fn as_u16(self) -> u16

fn as_u32(self) -> u32

fn as_u64(self) -> u64

fn as_u128(self) -> u128

fn as_usize(self) -> usize

fn as_i8(self) -> i8

fn as_i16(self) -> i16

fn as_i32(self) -> i32

fn as_i64(self) -> i64

fn as_i128(self) -> i128

fn as_isize(self) -> isize

fn to_unsigned(self) -> Self::UnsignedInteger

Converts the number to its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a zero extension. Types that are already unsigned will return themselves.

fn from_unsigned(value: Self::UnsignedInteger) -> Self

Converts the number from its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a sign extension, if this type is a signed type. Types that are already unsigned will return themselves.

fn value(self) -> i16

fn as_<T: Integer>(self) -> T

impl<const BITS: usize> Integer for Int<i32, BITS>

const BITS: usize = BITS

Number of bits that can fit in this type

const ZERO: Self

The number 0

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

type UnderlyingType = i32

type SignedInteger = Int<i32, BITS>

An equivalent type with the same number of bits but signed. If the type is already signed, this is the same type.

type UnsignedInteger = UInt<u32, BITS>

An equivalent type with the same number of bits but unsigned. If the type is already unsigned, this is the same type.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn new(value: i32) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn from_<T: Integer>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertible to T. Use Self::new for literals.

fn masked_new<T: Integer>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(self) -> u8

fn as_u16(self) -> u16

fn as_u32(self) -> u32

fn as_u64(self) -> u64

fn as_u128(self) -> u128

fn as_usize(self) -> usize

fn as_i8(self) -> i8

fn as_i16(self) -> i16

fn as_i32(self) -> i32

fn as_i64(self) -> i64

fn as_i128(self) -> i128

fn as_isize(self) -> isize

fn to_unsigned(self) -> Self::UnsignedInteger

Converts the number to its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a zero extension. Types that are already unsigned will return themselves.

fn from_unsigned(value: Self::UnsignedInteger) -> Self

Converts the number from its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a sign extension, if this type is a signed type. Types that are already unsigned will return themselves.

fn value(self) -> i32

fn as_<T: Integer>(self) -> T

impl<const BITS: usize> Integer for Int<i64, BITS>

const BITS: usize = BITS

Number of bits that can fit in this type

const ZERO: Self

The number 0

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

type UnderlyingType = i64

type SignedInteger = Int<i64, BITS>

An equivalent type with the same number of bits but signed. If the type is already signed, this is the same type.

type UnsignedInteger = UInt<u64, BITS>

An equivalent type with the same number of bits but unsigned. If the type is already unsigned, this is the same type.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn new(value: i64) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn from_<T: Integer>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertible to T. Use Self::new for literals.

fn masked_new<T: Integer>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(self) -> u8

fn as_u16(self) -> u16

fn as_u32(self) -> u32

fn as_u64(self) -> u64

fn as_u128(self) -> u128

fn as_usize(self) -> usize

fn as_i8(self) -> i8

fn as_i16(self) -> i16

fn as_i32(self) -> i32

fn as_i64(self) -> i64

fn as_i128(self) -> i128

fn as_isize(self) -> isize

fn to_unsigned(self) -> Self::UnsignedInteger

Converts the number to its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a zero extension. Types that are already unsigned will return themselves.

fn from_unsigned(value: Self::UnsignedInteger) -> Self

Converts the number from its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a sign extension, if this type is a signed type. Types that are already unsigned will return themselves.

fn value(self) -> i64

fn as_<T: Integer>(self) -> T

impl<const BITS: usize> Integer for Int<i8, BITS>

const BITS: usize = BITS

Number of bits that can fit in this type

const ZERO: Self

The number 0

const MIN: Self

Minimum value that can be represented by this type

const MAX: Self

Maximum value that can be represented by this type

type UnderlyingType = i8

type SignedInteger = Int<i8, BITS>

An equivalent type with the same number of bits but signed. If the type is already signed, this is the same type.

type UnsignedInteger = UInt<u8, BITS>

An equivalent type with the same number of bits but unsigned. If the type is already unsigned, this is the same type.

fn try_new(value: Self::UnderlyingType) -> Result<Self, TryNewError>

Creates a number from the given value, return None if the value is too large

fn new(value: i8) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when creating a value from a literal.

fn from_<T: Integer>(value: T) -> Self

Creates a number from the given value, throwing an error if the value is too large. This constructor is useful when the value is convertible to T. Use Self::new for literals.

fn masked_new<T: Integer>(value: T) -> Self

Creates an instance from the given value. Unlike the various new... functions, this will never fail as the value is masked to the result size.

fn as_u8(self) -> u8

fn as_u16(self) -> u16

fn as_u32(self) -> u32

fn as_u64(self) -> u64

fn as_u128(self) -> u128

fn as_usize(self) -> usize

fn as_i8(self) -> i8

fn as_i16(self) -> i16

fn as_i32(self) -> i32

fn as_i64(self) -> i64

fn as_i128(self) -> i128

fn as_isize(self) -> isize

fn to_unsigned(self) -> Self::UnsignedInteger

Converts the number to its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a zero extension. Types that are already unsigned will return themselves.

fn from_unsigned(value: Self::UnsignedInteger) -> Self

Converts the number from its unsigned equivalent. For types that have fewer bits than the underlying type, this involves a sign extension, if this type is a signed type. Types that are already unsigned will return themselves.

fn value(self) -> i8

fn as_<T: Integer>(self) -> T

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> LowerHex for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T, const BITS: usize> Mul for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

type Output = Int<T, BITS>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> MulAssign for Int<T, BITS>

where Self: Integer,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T, const BITS: usize> Neg for Int<T, BITS>

where Self: Integer<UnderlyingType = T>, T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

type Output = Int<T, BITS>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Not for Int<T, BITS>

type Output = Int<T, BITS>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> Octal for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T: Ord + SignedInteger + BuiltinInteger, const BITS: usize> Ord for Int<T, BITS>

fn cmp(&self, other: &Int<T, BITS>) -> 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 + SignedInteger + BuiltinInteger, const BITS: usize> PartialEq for Int<T, BITS>

fn eq(&self, other: &Int<T, BITS>) -> 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 + SignedInteger + BuiltinInteger, const BITS: usize> PartialOrd for Int<T, BITS>

fn partial_cmp(&self, other: &Int<T, BITS>) -> 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<'a, T: BuiltinInteger + SignedInteger, const BITS: usize> Product<&'a Int<T, BITS>> for Int<T, BITS>

where Self: Integer + Mul<Output = Self>,

fn product<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<T: BuiltinInteger + SignedInteger, const BITS: usize> Product for Int<T, BITS>

where Self: Integer + Mul<Output = Self>,

fn product<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by multiplying the items.

impl<T, TSHIFTBITS, const BITS: usize> Shl<TSHIFTBITS> for Int<T, BITS>

where T: Shl<TSHIFTBITS, Output = T> + Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger, TSHIFTBITS: TryInto<usize> + Copy,

type Output = Int<T, BITS>

The resulting type after applying the << operator.

fn shl(self, rhs: TSHIFTBITS) -> Self::Output

Performs the << operation.

impl<T, TSHIFTBITS, const BITS: usize> ShlAssign<TSHIFTBITS> for Int<T, BITS>

where Self: Integer, T: Shl<TSHIFTBITS, Output = T> + Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger, TSHIFTBITS: TryInto<usize> + Copy,

fn shl_assign(&mut self, rhs: TSHIFTBITS)

Performs the <<= operation.

impl<T, TSHIFTBITS, const BITS: usize> Shr<TSHIFTBITS> for Int<T, BITS>

where Self: Integer, T: Shr<TSHIFTBITS, Output = T> + Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger, TSHIFTBITS: TryInto<usize> + Copy,

type Output = Int<T, BITS>

The resulting type after applying the >> operator.

fn shr(self, rhs: TSHIFTBITS) -> Self::Output

Performs the >> operation.

impl<T, TSHIFTBITS, const BITS: usize> ShrAssign<TSHIFTBITS> for Int<T, BITS>

where Self: Integer, T: Shr<TSHIFTBITS, Output = T> + Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger, TSHIFTBITS: TryInto<usize> + Copy,

fn shr_assign(&mut self, rhs: TSHIFTBITS)

Performs the >>= operation.

impl<T, const BITS: usize> Sub for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

type Output = Int<T, BITS>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, const BITS: usize> SubAssign for Int<T, BITS>

where T: Shl<usize, Output = T> + Shr<usize, Output = T> + SignedInteger + BuiltinInteger,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<'a, T: BuiltinInteger + SignedInteger, const BITS: usize> Sum<&'a Int<T, BITS>> for Int<T, BITS>

where Self: Integer + Default + Add<Output = Self>,

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: BuiltinInteger + SignedInteger, const BITS: usize> Sum for Int<T, BITS>

where Self: Integer + Default + Add<Output = Self>,

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> UpperHex for Int<T, BITS>

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

Formats the value using the given formatter.

impl<T: Copy + SignedInteger + BuiltinInteger, const BITS: usize> Copy for Int<T, BITS>

impl<T: Eq + SignedInteger + BuiltinInteger, const BITS: usize> Eq for Int<T, BITS>

impl<const BITS: usize> SignedInteger for Int<i128, BITS>

impl<const BITS: usize> SignedInteger for Int<i16, BITS>

impl<const BITS: usize> SignedInteger for Int<i32, BITS>

impl<const BITS: usize> SignedInteger for Int<i64, BITS>

impl<const BITS: usize> SignedInteger for Int<i8, BITS>

impl<T: SignedInteger + BuiltinInteger, const BITS: usize> StructuralPartialEq for Int<T, BITS>