variable_size_byte_writer 0.1.2

A library for writing variable-size bytes into io::Write traited targets.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# variable_size_byte_writer


A Rust crate for writing variable-size bytes into io::Write traited targets.

Writes are internally buffered and so the usage of any additional buffering such as std::io::BufWriter is not recommended.

Note that VariableSizeByteWriter does not flush its internal buffer when dropped.

# Usage:


## Writing some unconventionally sized bytes into Vec<u8>


``` rust
use variable_size_byte_writer::*;

let mut target = Vec::new();
let mut writer = VariableSizeByteWriter::new();
let bytes = [(0x3F, 6),(0x1AFF, 13),(0x7, 3)];

bytes
    .iter()
    .for_each(|&(byte, bits)|
        writer.write_16(&mut target, byte, bits).unwrap()
    );

let mut padding = 0;
writer
    .flush_all_bytes(&mut target, &mut padding)
    .unwrap();

assert_eq!(padding, 2);
assert_eq!(target[..], [0xFF, 0xBF, 0x3E]);
```

## Writing a series of 7bit bytes into a file


``` rust
use std::fs::File;
use variable_size_byte_writer::*;

let mut writer = VariableSizeByteWriter::new();
let mut file = File::create("path").unwrap();

for variable in 0..0x8F {
    writer.write_8(&mut file, variable, 7).unwrap();
}

let mut padding = 0;
writer
    .flush_all_bytes(&mut file, &mut padding)
    .unwrap();
```

# License

variable_size_byte_writer is distributed under the terms of MIT licence.