allow user to ignore trailing bytes

gendx / lzma-rs

An LZMA decoder written in pure Rust

MIT License

127 stars 27 forks source link

Open Niedzwiedzw opened 2 years ago

Niedzwiedzw commented 2 years ago

it allows for user to ignore trailing bytes, which made the crate unusable for me personally

This pull request was tested by...

Niedzwiedzw commented 2 years ago

I have also considered feature flag given that this changes the API a bit, I'll leave it up to your judgement

7ERr0r commented 1 year ago

That's a breaking change. Your API functions have different params. I would suggest:

renaming your LzmaDecoder::new to maybe LzmaDecoder::new_with_options
renaming allow_trailing_bytes to allow_trailing_bytes_lzma since it's not effective for LZMA2 and XZ
maybe separating Options into LzmaOptions from StreamOptions

gendx commented 1 year ago

Breaking API changes are not a problem per se, as they can be guarded by features and a SemVer bump at the next release.
As far as I understand it, this new option only applies to the raw stream, and therefore doesn't need to be part of the LZMA2 and xz APIs (which can simply invoke the LZMA layer with the default option).
In any case, unit tests are needed.