Struct ari::BitField

#[repr(C)]
pub struct BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>,  { /* fields omitted */ }

a bitfield.

this is c ffi compatible, which means for example a [u8; 4] bitfield consumes 4 bytes of space. just like a u32-based c-style bitfield.

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

assert_eq!(x.value(), &[0, 0, 0, 0]);

x.set(0, true);
x.set(4, true);
x.set(8, true);
x.set(16, true);
x.set_value(20, 3, 7u64);

assert_eq!(x.get(0), true);
assert_eq!(x.get(4), true);
assert_eq!(x.get(8), true);
assert_eq!(x.get(16), true);
assert_eq!(x.get_value(20, 3): u64, 7);

assert_eq!(x.value(), &[17, 1, 113, 0]);

Methods

impl<TStorage, TAlignment> BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

pub fn new(storage: TStorage) -> Self

creates a new bitfield with the specified value.

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

assert_eq!(x.value(), &[0, 0, 0, 0]);

pub fn get(&self, index: usize) -> bool

retrieves the bit at index.

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

assert_eq!(x.get(0), false);

pub fn set(&mut self, index: usize, value: bool)

places value at the specified bit index.

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

x.set(0, true);

assert_eq!(x.get(0), true);

pub fn get_value<T>(&self, offset: usize, width: usize) -> T where
    T: From<u64>, 

retrieves the value at the specified bit range [offset..offset + width].

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

x.set_value(0, 5, 0xfffffu64);
assert_eq!(x.get_value::<u64>(0, 5), 31);

pub fn set_value<T>(&mut self, offset: usize, width: usize, value: T) where
    T: Into<u64>, 

places value at the specified bit range [offset..offset + width].

value is truncated if it exceeds the maximum representable value defined by (offset, width).

examples.

simple example.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

x.set_value(0, 5, 0xfffffu64);

assert_eq!(x.get_value(0, 5): u64, 31);

4 bit value truncated to 2 bits.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

x.set_value(0, 2, 0b1111u64);

assert_eq!(x.get_value(0, 4): u64, 0b11);

pub fn value(&self) -> &TStorage

returns the raw value of this bitfield.

examples.

let mut x: BitField<[u8; 4], u32> = BitField::new([0u8; 4]);

x.set(0, true);
x.set(4, true);
x.set(8, true);
x.set(16, true);
x.set_value(20, 3, 9u64);

assert_eq!(x.value(), &[17, 1, 17, 0]);

Trait Implementations

impl<TStorage: Clone, TAlignment: Clone> Clone for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

fn clone(&self) -> BitField<TStorage, TAlignment>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TStorage: Ord, TAlignment: Ord> Ord for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

fn cmp(&self, other: &BitField<TStorage, TAlignment>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<TStorage: Default, TAlignment: Default> Default for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

fn default() -> BitField<TStorage, TAlignment>

Returns the "default value" for a type.

impl<TStorage: PartialOrd, TAlignment: PartialOrd> PartialOrd<BitField<TStorage, TAlignment>> for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

fn partial_cmp(
    &self,
    other: &BitField<TStorage, TAlignment>
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<TStorage: PartialEq, TAlignment: PartialEq> PartialEq<BitField<TStorage, TAlignment>> for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

fn eq(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BitField<TStorage, TAlignment>) -> bool

This method tests for !=.

impl<TStorage: Copy, TAlignment: Copy> Copy for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

impl<TStorage: Eq, TAlignment: Eq> Eq for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

impl<TStorage: Debug, TAlignment: Debug> Debug for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

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

Formats the value using the given formatter.

impl<TStorage: Hash, TAlignment: Hash> Hash for BitField<TStorage, TAlignment> where
    TStorage: AsRef<[u8]> + AsMut<[u8]>, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].