Struct BitPack

pub struct BitPack<B> { /* private fields */ }

Implementations

impl<B> BitPack<B>

pub fn new(buff: B) -> Self

pub fn sum_bits(&self) -> usize

pub fn with_cursor(&mut self, cursor: usize) -> &mut Self

pub fn with_bits(&mut self, bits: usize) -> &mut Self

impl<B: AsRef<[u8]>> BitPack<B>

pub fn as_slice(&self) -> &[u8]

impl<'a> BitPack<&'a mut [u8]>

pub fn write(&mut self, value: u32, bits: usize) -> Result<(), usize>

use bitpack::BitPack;

let mut buff = [0; 2];

{
    let mut bitpack = BitPack::<&mut [u8]>::new(&mut buff);
    bitpack.write(10, 4).unwrap();
    bitpack.write(1021, 10).unwrap();
    bitpack.write(3, 2).unwrap();
}

assert_eq!(buff, [218, 255]);

impl<'a> BitPack<&'a [u8]>

pub fn read(&mut self, bits: usize) -> Result<u32, usize>

use bitpack::BitPack;

let mut buff = [218, 255];

let mut bitpack = BitPack::<&[u8]>::new(&buff);
assert_eq!(bitpack.read(4).unwrap(), 10);
assert_eq!(bitpack.read(10).unwrap(), 1021);
assert_eq!(bitpack.read(2).unwrap(), 3);

Trait Implementations

impl<B: Clone> Clone for BitPack<B>

fn clone(&self) -> BitPack<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for BitPack<B>

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

Formats the value using the given formatter.

impl<B: PartialEq> PartialEq for BitPack<B>

fn eq(&self, other: &BitPack<B>) -> 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<B: Eq> Eq for BitPack<B>

impl<B> StructuralPartialEq for BitPack<B>