Struct BitInt

pub struct BitInt<T: Signed + PrimInt, const N: u32>(/* private fields */);

BitInt is a type that represents a N-bit signed integer.

The largest size of N is equal to the size of the underlying type in bits.

Examples

use bit_int::BitInt;

let n = BitInt::<i32, 33>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

Implementations

impl<const N: u32> BitInt<i8, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i8, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i8, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<i8, 7>::BITS, 7);

impl<const N: u32> BitInt<i16, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i16, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i16, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<i16, 7>::BITS, 7);

impl<const N: u32> BitInt<i32, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i32, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i32, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<i32, 7>::BITS, 7);

impl<const N: u32> BitInt<i64, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i64, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i64, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<i64, 7>::BITS, 7);

impl<const N: u32> BitInt<i128, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i128, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<i128, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<i128, 7>::BITS, 7);

impl<const N: u32> BitInt<isize, N>

pub const MIN: Self = _

The smallest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<isize, 7>::MIN.get(), -64);

pub const MAX: Self = _

The largest value that can be represented by this BitInt.

Examples

assert_eq!(BitInt::<isize, 7>::MAX.get(), 63);

pub const BITS: u32 = N

The size of this BitInt in bits.

Examples

assert_eq!(BitInt::<isize, 7>::BITS, 7);

impl<const N: u32> BitInt<i8, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i8, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i8, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i8, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<i8, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<i8, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<i16, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i16, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i16, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i16, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<i16, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<i16, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<i32, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i32, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i32, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i32, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<i32, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<i32, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<i64, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i64, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i64, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i64, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<i64, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<i64, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<i128, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i128, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i128, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<i128, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<i128, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<i128, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<isize, N>

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

Computes self + rhs, returning None if overflow occurred.

Examples

let n = BitInt::<isize, 7>::new(42).unwrap();

assert_eq!(n.checked_add(21).map(BitInt::get), Some(63));
assert!(n.checked_add(22).is_none());

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

Computes self - rhs, returning None if overflow occurred.

Examples

let n = BitInt::<isize, 7>::new(-42).unwrap();

assert_eq!(n.checked_sub(22).map(BitInt::get), Some(-64));
assert!(n.checked_sub(23).is_none());

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

Computes self * rhs, returning None if overflow occurred.

Examples

let n = BitInt::<isize, 7>::new(21).unwrap();

assert_eq!(n.checked_mul(2).map(BitInt::get), Some(42));
assert!(n.checked_mul(4).is_none());

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

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

Examples

let n = BitInt::<isize, 7>::new(42).unwrap();

assert_eq!(n.checked_div(2).map(BitInt::get), Some(21));
assert!(n.checked_div(0).is_none());

assert!(BitInt::<isize, 7>::MIN.checked_div(-1).is_none());

impl<const N: u32> BitInt<i8, N>

pub const fn new(n: i8) -> Option<Self>

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<i8, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<i8, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<i8, 7>::MIN.is_positive());
assert!(BitInt::<i8, 7>::MAX.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

assert!(BitInt::<i8, 7>::MIN.is_negative());
assert!(!BitInt::<i8, 7>::MAX.is_negative());

impl<const N: u32> BitInt<i16, N>

pub const fn new(n: i16) -> Option<Self>

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<i16, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<i16, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<i16, 7>::MIN.is_positive());
assert!(BitInt::<i16, 7>::MAX.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

assert!(BitInt::<i16, 7>::MIN.is_negative());
assert!(!BitInt::<i16, 7>::MAX.is_negative());

impl<const N: u32> BitInt<i32, N>

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

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<i32, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<i32, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<i32, 7>::MIN.is_positive());
assert!(BitInt::<i32, 7>::MAX.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

assert!(BitInt::<i32, 7>::MIN.is_negative());
assert!(!BitInt::<i32, 7>::MAX.is_negative());

impl<const N: u32> BitInt<i64, N>

pub const fn new(n: i64) -> Option<Self>

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<i64, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<i64, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<i64, 7>::MIN.is_positive());
assert!(BitInt::<i64, 7>::MAX.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

assert!(BitInt::<i64, 7>::MIN.is_negative());
assert!(!BitInt::<i64, 7>::MAX.is_negative());

impl<const N: u32> BitInt<i128, N>

pub const fn new(n: i128) -> Option<Self>

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<i128, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<i128, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<i128, 7>::MIN.is_positive());
assert!(BitInt::<i128, 7>::MAX.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

assert!(BitInt::<i128, 7>::MIN.is_negative());
assert!(!BitInt::<i128, 7>::MAX.is_negative());

impl<const N: u32> BitInt<isize, N>

pub const fn new(n: isize) -> Option<Self>

Creates a new BitInt with the given signed integer value.

Returns None if the value is not a valid N-bit signed integer.

Examples

let n = BitInt::<isize, 7>::new(42);
assert_eq!(n.map(BitInt::get), Some(42));

let m = BitInt::<isize, 6>::new(42);
assert!(m.is_none());

pub const fn is_positive(self) -> bool

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

Examples

assert!(!BitInt::<isize, 7>::MIN.is_positive());
assert!(BitInt::<isize, 7>::MAX.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

assert!(BitInt::<isize, 7>::MIN.is_negative());
assert!(!BitInt::<isize, 7>::MAX.is_negative());

impl<T: Signed + PrimInt, const N: u32> BitInt<T, N>

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

Creates a new BitInt with the given signed integer value.

This method does not check whether the value is a valid N-bit signed integer. This results in undefined behaviour if the value is not a valid N-bit signed integer.

Safety

The value must be a valid N-bit signed integer.

pub const fn get(self) -> T

Returns the contained value as the underlying type.

Trait Implementations

impl<T: Signed + PrimInt + Binary, const N: u32> Binary for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Clone + Signed + PrimInt, const N: u32> Clone for BitInt<T, N>

fn clone(&self) -> BitInt<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Signed + PrimInt, const N: u32> Debug for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Default + Signed + PrimInt, const N: u32> Default for BitInt<T, N>

fn default() -> BitInt<T, N>

Returns the “default value” for a type.

impl<T: Signed + PrimInt + Display, const N: u32> Display for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Hash + Signed + PrimInt, const N: u32> Hash for BitInt<T, N>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Signed + PrimInt + LowerExp, const N: u32> LowerExp for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Signed + PrimInt + LowerHex, const N: u32> LowerHex for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Signed + PrimInt + Octal, const N: u32> Octal for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Ord + Signed + PrimInt, const N: u32> Ord for BitInt<T, N>

fn cmp(&self, other: &BitInt<T, N>) -> 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 + Signed + PrimInt, const N: u32> PartialEq for BitInt<T, N>

fn eq(&self, other: &BitInt<T, N>) -> 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 + Signed + PrimInt, const N: u32> PartialOrd for BitInt<T, N>

fn partial_cmp(&self, other: &BitInt<T, N>) -> 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<T: Signed + PrimInt + UpperExp, const N: u32> UpperExp for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Signed + PrimInt + UpperHex, const N: u32> UpperHex for BitInt<T, N>

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

Formats the value using the given formatter.

impl<T: Copy + Signed + PrimInt, const N: u32> Copy for BitInt<T, N>

impl<T: Eq + Signed + PrimInt, const N: u32> Eq for BitInt<T, N>

impl<T: Signed + PrimInt, const N: u32> StructuralPartialEq for BitInt<T, N>