Struct Reg32Bits 

pub struct Reg32Bits<const N: usize>(/* private fields */);

Implementations

impl Reg32Bits<NUM_BITS>

pub fn new(value: u32) -> Self

impl<const N: usize> Reg32Bits<N>

pub const ZEROS: Self

A guarenteed N sequential 0’s

pub const ONES: Self

N sequential 1’s

pub const fn bits(self) -> [u8; N]

Turn the register bits into a array of 1s and 0s

Can be used in both a const environment and at runtime. This function is especially useful when pattern matching.

use register_bits::prelude::*;
let value: Reg32Bits<4> =
    Reg32Bits::new(0b1010).take_low();

match value.bits() {
    [1, 0, 1, 0] => {
        // Wow, we matched the individual bits
    }
    _ => unreachable!(),
}

pub fn get(self, index: usize) -> Option<Reg32Bits<1>>

Fetch a bit at runtime

This will fail if index >= N, where N is the size of the Reg32Bits.

use register_bits::prelude::*;

let bits: Reg32Bits<4> =
    Reg32Bits::new(0b1100).take_low();

assert_eq!(bits.get(0).unwrap(), 0u8);
assert_eq!(bits.get(1).unwrap(), 0u8);
assert_eq!(bits.get(2).unwrap(), 1u8);
assert_eq!(bits.get(3).unwrap(), 1u8);
assert_eq!(bits.get(4), None);

pub fn one_count(self) -> usize

Give the number of ones in the bits

pub fn zero_count(self) -> usize

Give the number of ones in the bits

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl<const N: usize, T: Into<u32>> Add<T> for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<const N: usize> AsRef<u32> for Reg32Bits<N>

fn as_ref(&self) -> &u32

Converts this type into a shared reference of the (usually inferred) input type.

impl<const N: usize> BitAnd for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const N: usize> BitOr for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const N: usize> BitXor for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<const N: usize> Deref for Reg32Bits<N>

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const N: usize, T: Into<u32>> Div<T> for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl From<Reg32Bits<1>> for bool

fn from(item: Reg32Bits<1>) -> bool

Converts to this type from the input type.

impl<const N: usize> From<Reg32Bits<N>> for u32

fn from(item: Reg32Bits<N>) -> Self

Converts to this type from the input type.

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

type Output = Reg32Bits<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<bool> for Reg32Bits<1>

fn eq(&self, other: &bool) -> 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 PartialEq<u8> for Reg32Bits<1>

fn eq(&self, other: &u8) -> 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> PartialEq for Reg32Bits<N>

fn eq(&self, other: &Reg32Bits<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 Reg32Bits<N>

fn partial_cmp(&self, other: &Reg32Bits<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> Reg32BitsBitSize for Reg32Bits<N>

const BIT_SIZE: usize = N

const BASE_ONES: u32 = Reg32Bits<N>::BASE_ONES

impl<const F: usize, const T: usize> Reg32BitsUpCast<T> for Reg32Bits<F>

where Reg32Bits<T>: Reg32BitsDownCast<F>,

fn zero_extend(self) -> Reg32Bits<T>

Extend the current register bits with 0s on the most significant bits

fn sign_extend(self) -> Reg32Bits<T>

Extend the current register bits by copied the most significant bit to the new bits

fn zero_pad(self) -> Reg32Bits<T>

Add extra zeros for the least significant bits

impl<const N: usize, T: Into<u32>> Rem<T> for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<const N: usize, T> Shl<T> for Reg32Bits<N>

where u32: Shl<T, Output = u32>,

type Output = Reg32Bits<N>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<const N: usize, T> Shr<T> for Reg32Bits<N>

where u32: Shr<T, Output = u32>,

type Output = Reg32Bits<N>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<const N: usize, T: Into<u32>> Sub<T> for Reg32Bits<N>

type Output = Reg32Bits<N>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<const N: usize> Copy for Reg32Bits<N>

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

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