robin/bitbuffer
1
0
Fork 0
mirror of https://codeberg.org/icewind/bitbuffer.git synced 2026-06-03 16:44:06 +02:00
Code Issues Releases Wiki Activity

rename to bitstream_reader

Browse source
This commit is contained in:
Robin Appelman 2019-02-21 22:54:32 +01:00
commit 159ee1df6c
3 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Cargo.toml
View file

@ -1,5 +1,5 @@
[package] [package]
name = "bitbuffer" name = "bitstream_reader"
version = "0.1.0" version = "0.1.0"
authors = ["Robin Appelman <robin@icewind.nl>"] authors = ["Robin Appelman <robin@icewind.nl>"]
edition = "2018" edition = "2018"

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# bitstream_reader
Reading bit sequences from a byte slice in rust
## Example
```rust
use bitstream_reader::{BitBuffer, LittleEndian};
let bytes: &[u8] = &[
0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
];
let buffer: BitBuffer<LittleEndian> = BitBuffer::new(bytes);
let result = buffer.read::<u16>(10, 9).unwrap();
```
You can read up to a maximum of 64 bit.

10
src/lib.rs
View file

@ -60,7 +60,7 @@ impl<'a, E> BitBuffer<'a, E> where E: Endianness {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use bitbuffer::{BitBuffer, LittleEndian}; /// use bitstream_reader::{BitBuffer, LittleEndian};
/// ///
/// let bytes: &[u8] = &[ /// let bytes: &[u8] = &[
/// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001, /// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
@ -124,7 +124,7 @@ impl<'a, E> BitBuffer<'a, E> where E: Endianness {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use bitbuffer::{BitBuffer, LittleEndian}; /// use bitstream_reader::{BitBuffer, LittleEndian};
/// ///
/// let bytes: &[u8] = &[ /// let bytes: &[u8] = &[
/// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001, /// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
@ -160,7 +160,7 @@ impl<'a, E> BitBuffer<'a, E> where E: Endianness {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use bitbuffer::{BitBuffer, LittleEndian}; /// use bitstream_reader::{BitBuffer, LittleEndian};
/// ///
/// let bytes: &[u8] = &[ /// let bytes: &[u8] = &[
/// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001, /// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
@ -237,7 +237,7 @@ impl<'a, E> BitBuffer<'a, E> where E: Endianness {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use bitbuffer::{BitBuffer, LittleEndian}; /// use bitstream_reader::{BitBuffer, LittleEndian};
/// ///
/// let bytes: &[u8] = &[ /// let bytes: &[u8] = &[
/// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001, /// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
@ -274,7 +274,7 @@ impl<'a, E> BitBuffer<'a, E> where E: Endianness {
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use bitbuffer::{BitBuffer, LittleEndian}; /// use bitstream_reader::{BitBuffer, LittleEndian};
/// ///
/// let bytes: &[u8] = &[ /// let bytes: &[u8] = &[
/// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001, /// 0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,