alexcrichton / alexcrichton/xz2-rs

Document a way to (effectively) disable decoder stream memory limit

Open
#129 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
93
Forks
67
PR merge metrics
No merged PRs in 30d

Description

`liblzma` has [this](https://github.com/kobolabs/liblzma/blob/87b7682c/src/liblzma/api/lzma/container.h#L328-L329) in its docs:

```
* \param memlimit Memory usage limit as bytes. Use UINT64_MAX
* to effectively disable the limiter.
```

This should be documented in the Rust API.

Or, alternatively, replace `limit: u64` with `limit: Option`, in the API and do `let limit = limit.or(u64::MAX)` on the Rust side.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.