sleep-parser 0.7.0

Parse Dat protocol SLEEP files
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

# sleep-parser
[![crates.io version][1]][2] [![build status][3]][4]
[![downloads][5]][6] [![docs.rs docs][7]][8]

Parse [Dat protocol SLEEP
files](https://github.com/datproject/docs/blob/master/papers/sleep.md).

- [Documentation][8]
- [Crates.io][2]

## Usage
```rust
extern crate sleep_parser as sleep_parser;

use sleep_parser::{FileType, HashType, Header};
use std::fs::File;
use std::io::{BufRead, BufReader};

let file = File::open("tests/fixtures/content.bitfield").unwrap();
let mut reader = BufReader::with_capacity(32, file);
let buffer = reader.fill_buf().unwrap();
let header = Header::from_vec(&buffer).unwrap();
assert!(header.is_bitfield());
```

## Format
```txt,ignore
<32 byte header>
  <4 byte magic string: 0x05025702>
  <1 byte version number: 0>
  <2 byte entry size: 40>
  <1 byte algorithm name length prefix: 7>
  <7 byte algorithm name: BLAKE2b>
  <17 zeroes>
<40 byte entries>
  <32 byte BLAKE2b hash>
  <8 byte Uint64BE children leaf byte length>
```

## Installation
```sh
$ cargo add sleep-parser
```

## License
[MIT](./LICENSE-MIT) or [Apache-2.0](./LICENSE-APACHE)

[1]: https://img.shields.io/crates/v/sleep-parser.svg?style=flat-square
[2]: https://crates.io/crates/sleep-parser
[3]: https://img.shields.io/travis/datrs/sleep-parser.svg?style=flat-square
[4]: https://travis-ci.org/datrs/sleep-parser
[5]: https://img.shields.io/crates/d/sleep-parser/master.svg?style=flat-square
[6]: https://crates.io/crates/sleep-parser
[7]: https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square
[8]: https://docs.rs/sleep-parser