lzvn 0.1.1

Safe, clean-room LZVN encode/decode support for raw streams and Apple wrappers
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
56
57
58
59
60
61
62
63

# lzvn

[![crates.io](https://img.shields.io/crates/v/lzvn.svg)](https://crates.io/crates/lzvn)
[![docs.rs](https://docs.rs/lzvn/badge.svg)](https://docs.rs/lzvn)

`lzvn` is a safe, clean-room Rust implementation of Apple's LZVN format.

Current scope:

- raw LZVN stream encoding
- raw LZVN stream decoding
- incremental raw encoder and decoder state machines
- Apple `bvxn` block encoding
- Apple `bvxn` block decoding
- incremental `bvxn` encoder and decoder state machines
- Apple `decmpfs` xattr and resource-fork encode/decode helpers for LZVN
- no `unsafe` code
- Apache-2.0 licensing

Planned next steps:

- higher-level APFS / HFS+ integration helpers
- fuzzing, benchmarks, and differential tests against Apple-compatible output

Validation:

- `cargo test`
- `cargo test --test differential`
- `cargo clippy --all-targets --all-features -- -D warnings`
- `cargo bench`

Release:

- push a tag matching the crate version, for example `0.1.1`, to trigger the release workflow
- the workflow verifies the tag matches `Cargo.toml`, runs clippy and tests, packages the crate, and creates a GitHub release with the `.crate` file and sha256 checksum

Fuzzing:

- install `cargo-fuzz` with `cargo install cargo-fuzz`
- run `cargo fuzz run raw_decode`
- run `cargo fuzz run bvxn_decode`
- run `cargo fuzz run decmpfs_decode`
- run `cargo fuzz run roundtrip`

Fixtures:

- real-world regression fixtures live in `tests/fixtures/`
- source urls and license notes are documented in `tests/fixtures/README.md`
- fuzz seed corpora live in `fuzz/corpus/`

Install:

- `cargo add lzvn`

Example:

```rust
let encoded = lzvn::encode_raw(b"hello");
let decoded = lzvn::decode_raw(&encoded, 5)?;

assert_eq!(decoded, b"hello");
# Ok::<(), lzvn::Error>(())
```