Crate bitterlemon

An RLE-based encoder and decoder for bit streams.

Example

use std::iter;

// Create input bit stream from a variety of different generators
// With standard bit packing, this takes 17 bytes
let tmp = &[true, false];
let input = iter::repeat(true).take(50)
    .chain(iter::repeat(false).take(51))
    .chain(tmp.iter().copied().cycle().take(33));

let output : Vec<_> = bitterlemon::encode(input).collect();
// Bitterlemon gets this down to 8 bytes
assert_eq!(b"\xf2\xb3\x21\xaa\xaa\xaa\xaa\x80", output.as_slice());

let decoded : Result<Vec<_>, _> = bitterlemon::decode(output.into_iter()).collect();
assert!(decoded.is_ok());
let decoded = decoded.unwrap();
assert_eq!(134, decoded.len());

Structs

• Decoder
  Manages the state for decoding a Bitterlemon byte stream.
• Encoder
  The state for the encode process.

Enums

• Error
  Describes errors that can occur when decoding a Bitterlemon byte stream.

Functions

• decode
  Decodes a Bitterlemon byte stream into an iterator of bools. source can be any iterator that yields u8 values.
• encode
  Encodes a given bit stream into a compact byte representation. source can be any iterator that yields bool values.

Type Aliases

• Result
  Decode operations yield this on each iteration.