Implement decode and fix a bug in decode_len

datrs / bitfield-rle

A run-length-encoder that compresses bitfields.

https://docs.rs/bitfield-rle

Apache License 2.0

9 stars 6 forks source link

Implement decode and fix a bug in decode_len #8

Closed theorangepotato closed 4 years ago

theorangepotato commented 5 years ago

Choose one: 🙋 feature

Checklist

[x] tests and/or benchmarks are included
- [x] added tests pass
[x] documentation is changed

Context

decoding_len_with_offset() had a bug where it was using the wrong variable as the varint (bytes_encoded instead of val).
Made the decode API more consistent. Prior, it was confused as to whether it was passing in a mutable buffer to functions or should be recieving a Vec in return.
Renamed decoding_len() to decode_len and deleted the previous empty decode_len().
Added a test each for decode() and decode_len(), both based on the example bitfield in the dat protocol.

Semver Changes

Should probably bump to 0.1.0, given that this adds features.

theorangepotato commented 5 years ago

The README says that bitfield_rle::encode() should take a sparse_bitfield::Bitfield. Is it also desirable for bitfield_rle::decode() to output a sparse_bitfield::Bitfield? I don't think the modification would be very hard, but might limit interoperability.

khernyo commented 4 years ago

Thanks for this PR, it's great!

The README says that bitfield_rle::encode() should take a sparse_bitfield::Bitfield. Is it also desirable for bitfield_rle::decode() to output a sparse_bitfield::Bitfield? I don't think the modification would be very hard, but might limit interoperability.

I don't really have an opinion about this as I'm not familiar with its usage. I wouldn't change it just because the README says it has a different API, but if it helps somewhere, sure go ahead and change it.