MCPcopy Index your code
hub / github.com/GoogleChrome/ripunzip

github.com/GoogleChrome/ripunzip @v2.0.4

Chat with this repo
repository ↗ · DeepWiki ↗ · release v2.0.4 ↗ · + Follow
155 symbols 338 edges 10 files 47 documented · 30%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

ripunzip

GitHub crates.io docs.rs

A tool to unzip files in parallel.

This is a Rust library (and command-line tool) which utilises the power of Rust's rayon library to unzip a zip file in parallel. If you're fetching the zip file from a URI, it may also be able to start unzipping in parallel with the download.

Installation and use

To fetch the command-line tool: cargo install ripunzip then ripunzip -h. Alternatively, a .deb file is available under the "releases" section on github.

To add the library to your project: cargo add ripunzip and check out the documentation linked above.

Development

Pull requests are welcome - see the contributing doc. The focus of this project remains efficiently unzipping entire zip files, and any speed increases are greatly appreciated! cargo criterion is used for performance testing, though the benchmark suite doesn't do a great job of simulating real conditions. In particular please be aware that this tool is often used on devices with spinny hard disks and very limited disk write bandwidth, so in different circumstances that may be the limiting circumstance, or network bandwidth, or CPU time. Please consider the impact of your changes on all these permutations.

Release procedure:

  1. Revise the version number.
  2. cargo publish
  3. Create a new release and tag on github.

There's also cargo fuzz support for comparitive fuzzing against non-parallel unzipping to try to spot any unforeseen circumstances where we do anything differently. If you change the core unzipping logic please use this.

License and usage notes

This is not an officially supported Google product.

License

This software is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE for details.

Extension points exported contracts — how you extend this code

UnzipProgressReporter (Interface)
A trait of types which wish to hear progress updates on the unzip. [2 implementers]
src/unzip/mod.rs
FilenameFilter (Interface)
Code which can determine whether to unzip a given filename. [2 implementers]
src/unzip/mod.rs
UnzipEngineImpl (Interface)
The underlying engine used by the unzipper. This is different for files and URIs. [2 implementers]
src/unzip/mod.rs

Core symbols most depended-on inside this repo

clone
called by 20
src/unzip/multi_file_seeker.rs
finish
called by 9
src/unzip/progress_updater.rs
len
called by 9
src/unzip/seekable_http_reader.rs
progress
called by 7
src/unzip/progress_updater.rs
unzip
called by 6
src/unzip/mod.rs
get_range_expectation
called by 6
src/unzip/seekable_http_reader.rs
len
called by 6
src/unzip/http_range_reader.rs
run_with_and_without_a_filename_filter
called by 4
src/unzip/mod.rs

Shape

Function 62
Method 50
Class 27
Enum 13
Interface 3

Languages

Rust100%

Modules by API surface

src/unzip/mod.rs42 symbols
src/unzip/seekable_http_reader.rs31 symbols
src/main.rs19 symbols
test_utils/src/lib.rs17 symbols
src/unzip/http_range_reader.rs10 symbols
fuzz/fuzz_targets/fuzz_ripunzip.rs10 symbols
src/unzip/progress_updater.rs9 symbols
benches/ripunzip_benchmark.rs9 symbols
src/unzip/multi_file_seeker.rs5 symbols
src/lib.rs3 symbols

For agents

$ claude mcp add ripunzip \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact