luizirber / niffler

Simple and transparent support for compressed files.
Apache License 2.0
75 stars 7 forks source link

Add benchmark #25

Closed natir closed 4 years ago

natir commented 4 years ago

I create this pull request to track the changes needed to set up a niffler benchmark and discuss these changes. #25

Main todolist:

Side effect todolist

codecov[bot] commented 4 years ago

Codecov Report

Merging #25 into master will decrease coverage by 0.03%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #25      +/-   ##
==========================================
- Coverage   98.68%   98.64%   -0.04%     
==========================================
  Files           2        2              
  Lines         152      148       -4     
==========================================
- Hits          150      146       -4     
  Misses          2        2              
Impacted Files Coverage Δ
src/compression.rs 98.46% <100.00%> (-0.54%) :arrow_down:
src/lib.rs 98.79% <100.00%> (+0.71%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d4b8dde...025c7c7. Read the comment docs.

natir commented 4 years ago

I had to make the format detection function read_compression public, I'll have to write its documentation and maybe change its name to compression_detection @luizirber do you have an opinion about that name?

natir commented 4 years ago

To change where the file is write on disk set environement variable TMPDIR

natir commented 4 years ago

@luizirber If it's ok for you I think we can merge.

In think, the add of sniff in public API didn't break compatibility with the previous version so if we want create a new release the version number is 2.1.0. I think we don't need to create a new release for this little change.

natir commented 4 years ago

If you want correct typo I write in the documentation please do it :)

luizirber commented 4 years ago

@natir do the changes in https://github.com/luizirber/niffler/pull/25/commits/025c7c7411da17457b2504ba4878306f9920e998 look good? If yes, feel free to merge =]