Struct Bits32

pub struct Bits32 { /* private fields */ }

32bits container where you can push and pop multiple bits as a integer.

See the crate level documentaion for more details.

Implementations

impl Bits32

pub const BIT_WIDTH: u32 = 32u32

Bit width of this container.

pub fn new(bits: u32) -> Self

Create a new Bits32 container with the given bit pattern.

pub fn get(&self) -> u32

Copy out the current bit pattern of this container.

Example

let mut bits = Bits32::new(0);
bits.push(5, 0b10110_u16);
bits.push_bool(true);
assert_eq!(0b10110_1, bits.get());

pub fn push<T: Into<u32>>(&mut self, num_bits: u32, value: T)

Push given number of bits into the LSB of this container using the bit shift left operation.

Panics

It panics if the num_bits is greater than 31.

Examples

let mut bits = Bits32::new(0);
bits.push(8, 0b11100110_u32);
bits.push(5, 0b10001_u8);
assert_eq!(0b11100110_10001, bits.get());

pub fn push_bool(&mut self, value: bool)

Push a boolean as a single bit.

Examples

let mut bits = Bits32::new(0);
bits.push_bool(true);
bits.push_bool(false);
assert_eq!(0b10, bits.get());

pub fn pop(&mut self, num_bits: u32) -> u32

Pop given number of bits out from the MSB of this container using the bit shift left operation.

Panics

It panics if the num_bits is greater than 31.

Examples

let mut bits = Bits32::new(0xDEADBEEF);
assert_eq!(0xDEA, bits.pop(12));
assert_eq!(0xDBE, bits.pop(12));
assert_eq!(0xEF, bits.pop(8));

pub fn pop_bool(&mut self) -> bool

Pop a single bit out as a boolean.

Examples

let mut bits = Bits32::new(0b101);
bits.push(Bits32::BIT_WIDTH - 3, 0_u32);
assert_eq!(true, bits.pop_bool());
assert_eq!(false, bits.pop_bool());
assert_eq!(true, bits.pop_bool());

Trait Implementations

impl Clone for Bits32

fn clone(&self) -> Bits32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Bits32

fn default() -> Bits32

Returns the “default value” for a type.

impl Ord for Bits32

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bits32

fn eq(&self, other: &Bits32) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Bits32

fn partial_cmp(&self, other: &Bits32) -> 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 Eq for Bits32

impl StructuralPartialEq for Bits32