bitlab

Extracting a range of bits from binary data

Objective:

To help developing applications, which extract bit level data from a binary source such as spacecraft telemetry

Status

Experimental

Documentation

This crate is published at crates.io. The detailed documentation is available at docs.rs/bitlab

Version

0.1.4

Installation

Just add the following line under [dependencies] to your Cargo.toml file

bitlab = "0.1.4"

Examples

Example 1:

To extract 3 bits starting at bit index 5 within a byte (0xFF) and interpret them as an unsigned integer

use bitlab::*;
let a = 0xFFu8;
let b = a.get_u8(5, 3).unwrap();
assert_eq!(b, 7);

Example 2:

The data source is a vector of u8 types. We want to go to byte offset 1, bit offset 7 and starting from there extract 3 bits as an u16

use bitlab::*;
let v: Vec<u8> = vec!{ 0x48, 0x61, 0x6C, 0x6C, 0x6F }; // = "Hallo"
let bar = u16(&v, 1, 7, 3); // relevant bytes = 0x616C = 0b0110000  --> 101 <-- 101100
assert_eq!(bar.unwrap(), 5);