Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
PSeitz committed Jun 18, 2023
1 parent c516afb commit c836289
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ homepage = "https://github.com/pseitz/lz4_flex"
repository = "https://github.com/pseitz/lz4_flex"
readme = "README.md"
license = "MIT"
version = "0.10.0"
version = "0.11.0"
include = ["src/*.rs", "src/frame/**/*", "src/block/**/*", "README.md"]

[package.metadata.docs.rs]
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,23 @@ Compression and decompression uses no usafe via the default feature flags "safe-

Safe:
```
lz4_flex = { version = "0.10" }
lz4_flex = { version = "0.11" }
```

Performance:
```
lz4_flex = { version = "0.10", default-features = false }
lz4_flex = { version = "0.11", default-features = false }
```

If you know guaranteed your data is valid and not broken or corrupted, you can use `unchecked-decode` feature-flag to get a little bit more performance during decompression.
Ususally you don't want this, use case may be:
- Compression/Decompression happens in memory.
- You run sandboxed so out of bounds reads/writes are not a problem.
- You data is checked against a checksum.
- The compression runs sandboxed so out of bounds reads/writes are not a problem.
- The data is checked against a checksum.
```
lz4_flex = { version = "0.10", default-features = false, features = ["unchecked-decode"] }
lz4_flex = { version = "0.11", default-features = false, features = ["unchecked-decode"] }
```


### Block Format
The block format is only valid for smaller data chunks as as block is de/compressed in memory.
For larger data use the frame format, which consists of multiple blocks.
Expand Down

0 comments on commit c836289

Please sign in to comment.