Struct NBits

pub struct NBits<const N: usize>(pub [u8; N]);

NBits is a wrapper around an array of bytes that provides arithmetic and bitwise operations on the bits represented by the bytes. The operations are performed in big-endian order.

Tuple Fields

0: [u8; N]

Implementations

impl<const N: usize> NBits<N>

pub fn new() -> Self

Creates a new NBits instance with all bits set to 0.

Trait Implementations

impl<const N: usize> Add<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the + operator.

fn add(self, other: &Self) -> Self::Output

Performs the + operation.

impl<const N: usize, U: Into<u64>> Add<U> for NBits<N>

type Output = NBits<N>

The resulting type after applying the + operator.

fn add(self, other: U) -> Self::Output

Performs the + operation.

impl<const N: usize> AddAssign<&NBits<N>> for NBits<N>

fn add_assign(&mut self, other: &Self)

Performs the += operation.

impl<const N: usize, U: Into<u64>> AddAssign<U> for NBits<N>

fn add_assign(&mut self, other: U)

Performs the += operation.

impl<const N: usize> BitAnd<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the & operator.

fn bitand(self, other: &Self) -> Self::Output

Performs the & operation.

impl<const N: usize> BitAndAssign<&NBits<N>> for NBits<N>

fn bitand_assign(&mut self, other: &Self)

Performs the &= operation.

impl<const N: usize> BitOr<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the | operator.

fn bitor(self, other: &Self) -> Self::Output

Performs the | operation.

impl<const N: usize> BitOrAssign<&NBits<N>> for NBits<N>

fn bitor_assign(&mut self, other: &Self)

Performs the |= operation.

impl<const N: usize> BitXor<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the ^ operator.

fn bitxor(self, other: &Self) -> Self::Output

Performs the ^ operation.

impl<const N: usize> BitXorAssign<&NBits<N>> for NBits<N>

fn bitxor_assign(&mut self, other: &Self)

Performs the ^= operation.

impl<const N: usize> Clone for NBits<N>

fn clone(&self) -> NBits<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for NBits<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for NBits<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Display for NBits<N>

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

Formats the value using the given formatter.

impl<const N: usize> Div<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the / operator.

fn div(self, other: &Self) -> Self::Output

Performs the / operation.

impl<const N: usize, U: Into<u64>> Div<U> for NBits<N>

type Output = NBits<N>

The resulting type after applying the / operator.

fn div(self, other: U) -> Self::Output

Performs the / operation.

impl<const N: usize> DivAssign<&NBits<N>> for NBits<N>

fn div_assign(&mut self, other: &Self)

Performs the /= operation.

impl<const N: usize, U: Into<u64>> DivAssign<U> for NBits<N>

fn div_assign(&mut self, other: U)

Performs the /= operation.

impl<const N: usize> Hash for NBits<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<const N: usize> Mul<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the * operator.

fn mul(self, other: &Self) -> Self::Output

Performs the * operation.

impl<const N: usize, U: Into<u64>> Mul<U> for NBits<N>

type Output = NBits<N>

The resulting type after applying the * operator.

fn mul(self, other: U) -> Self::Output

Performs the * operation.

impl<const N: usize> MulAssign<&NBits<N>> for NBits<N>

fn mul_assign(&mut self, other: &Self)

Performs the *= operation.

impl<const N: usize, U: Into<u64>> MulAssign<U> for NBits<N>

fn mul_assign(&mut self, other: U)

Performs the *= operation.

impl<const N: usize> Not for NBits<N>

type Output = NBits<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const N: usize> Ord for NBits<N>

fn cmp(&self, other: &NBits<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<const N: usize> PartialEq for NBits<N>

fn eq(&self, other: &NBits<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<const N: usize> PartialOrd for NBits<N>

fn partial_cmp(&self, other: &NBits<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<const N: usize> Rem<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the % operator.

fn rem(self, other: &Self) -> Self::Output

Performs the % operation.

impl<const N: usize, U: Into<u64>> Rem<U> for NBits<N>

type Output = NBits<N>

The resulting type after applying the % operator.

fn rem(self, other: U) -> Self::Output

Performs the % operation.

impl<const N: usize> RemAssign<&NBits<N>> for NBits<N>

fn rem_assign(&mut self, other: &Self)

Performs the %= operation.

impl<const N: usize, U: Into<u64>> RemAssign<U> for NBits<N>

fn rem_assign(&mut self, other: U)

Performs the %= operation.

impl<const N: usize> Shl<usize> for NBits<N>

type Output = NBits<N>

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl<const N: usize> ShlAssign<usize> for NBits<N>

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<const N: usize> Shr<usize> for NBits<N>

type Output = NBits<N>

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl<const N: usize> ShrAssign<usize> for NBits<N>

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<const N: usize> Sub<&NBits<N>> for NBits<N>

type Output = NBits<N>

The resulting type after applying the - operator.

fn sub(self, other: &Self) -> Self::Output

Performs the - operation.

impl<const N: usize, U: Into<u64>> Sub<U> for NBits<N>

type Output = NBits<N>

The resulting type after applying the - operator.

fn sub(self, other: U) -> Self::Output

Performs the - operation.

impl<const N: usize> SubAssign<&NBits<N>> for NBits<N>

fn sub_assign(&mut self, other: &Self)

Performs the -= operation.

impl<const N: usize, U: Into<u64>> SubAssign<U> for NBits<N>

fn sub_assign(&mut self, other: U)

Performs the -= operation.

impl<const N: usize> Eq for NBits<N>

impl<const N: usize> StructuralPartialEq for NBits<N>