DevComp/zip-rs-wasm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
compiling the zip2 crate to wasm with the goal of compiling to luau through wasynth
2124 commits 1 branch 0 tags 52 MiB
Find a file
Chris Hennick 8b11361b9e
chore: release
2024-07-18 15:34:03 -07:00
.github ci(fuzz): Set max length closer to current corpus entries' length 2024-07-18 22:18:58 +00:00
benches Bug fix: len() is must-use 2024-05-24 13:08:05 -07:00
examples Merge branch 'master' into utf8_extra_fields 2024-06-02 17:52:04 -07:00
fuzz Commit unfinished corpus 2024-07-18 21:02:19 +00:00
security-advisories in-source vulnerability tracking 2023-09-19 18:55:01 +01:00
src Fix divergence from origin/master 2024-07-18 21:02:19 +00:00
tests Merge branch 'master' into fix/soft-links-should-remain-the-same 2024-07-08 17:15:38 +03:00
.gitattributes test: Add .gitattributes to force test data files to be binary 2024-05-21 09:15:44 -07:00
.gitignore Ignore .DS_Store files 2024-04-17 19:19:54 -07:00
.whitesource Add .whitesource configuration file 2023-04-23 21:33:22 +00:00
build-fuzz-corpus-multiple-restarts.sh Revert "test(fuzz): Make the choice of no dictionary explicit" 2024-07-08 08:57:54 -07:00
build-fuzz-corpus-multiple-sizes.sh test(fuzz): Fix another off-by-one error involving 2-byte exhaustive entries 2024-06-25 20:31:50 -07:00
Cargo.toml chore: release 2024-07-18 15:34:03 -07:00
CHANGELOG.md chore: release 2024-07-18 15:34:03 -07:00
cliff.toml doc: exclude doc updates from CHANGELOG 2024-04-22 19:18:15 -07:00
CODE_OF_CONDUCT.md doc: veeeery small fix to CoC 2022-01-23 17:35:39 +03:00
CONTRIBUTING.md Make CONTRIBUTING.md link to pull_request_template.md 2024-05-09 19:41:26 -07:00
fuzz-until-converged.sh test(fuzz): Increase runs per fuzz_until_converged.sh iteration to 25m when time allows 2024-06-29 20:01:15 -07:00
LICENSE doc: Add some missing license information 2024-05-19 11:47:12 -07:00
pull_request_template.md doc: Commit signing is no longer required 2024-07-06 11:59:33 -07:00
README.md Update documented default features 2024-05-26 00:02:01 -04:00
recursive-fuzz-cmin.sh test(fuzz): Refactor: move and re-create directory rather than contents, when possible 2024-07-06 16:07:33 -07:00
release-plz.toml doc: exclude doc updates from CHANGELOG 2024-04-22 19:18:15 -07:00

README.md

zip

Build Status Crates.io version

Documentation

Info

A zip library for rust which supports reading and writing of simple ZIP files. Formerly hosted at https://github.com/zip-rs/zip2.

Supported compression formats:

  • stored (i.e. none)
  • deflate
  • deflate64 (decompression only)
  • bzip2
  • zstd
  • lzma (decompression only)

Currently unsupported zip extensions:

  • Multi-disk

Features

The features available are:

  • aes-crypto: Enables decryption of files which were encrypted with AES. Supports AE-1 and AE-2 methods.
  • deflate: Enables compressing and decompressing an unspecified implementation (that may change in future versions) of the deflate compression algorithm, which is the default for zip files. Supports compression quality 1..=264.
  • deflate-flate2: Combine this with any flate2 feature flag that enables a back-end, to support deflate compression at quality 1..=9.
  • deflate-zopfli: Enables deflating files with the zopfli library (used when compression quality is 10..=264). This is the most effective deflate implementation available, but also among the slowest.
  • deflate64: Enables the deflate64 compression algorithm. Only decompression is supported.
  • lzma: Enables the LZMA compression algorithm. Only decompression is supported.
  • bzip2: Enables the BZip2 compression algorithm.
  • time: Enables features using the time crate.
  • chrono: Enables converting last-modified zip::DateTime to and from chrono::NaiveDateTime.
  • zstd: Enables the Zstandard compression algorithm.

By default aes-crypto, bzip2, deflate, deflate64, lzma, time and zstd are enabled.

The following feature flags are deprecated:

  • deflate-miniz: Use flate2's default backend for compression. Currently the same as deflate.

MSRV

Our current Minimum Supported Rust Version is 1.73. When adding features, we will follow these guidelines:

  • We will always support the latest four minor Rust versions. This gives you a 6 month window to upgrade your compiler.
  • Any change to the MSRV will be accompanied with a minor version bump.

Examples

See the examples directory for:

  • How to write a file to a zip.
  • How to write a directory of files to a zip (using walkdir).
  • How to extract a zip file.
  • How to extract a single file from a zip.
  • How to read a zip from the standard input.
  • How to append a directory to an existing archive

Fuzzing

Fuzzing support is through cargo fuzz. To install cargo fuzz:

cargo install cargo-fuzz

To list fuzz targets:

cargo +nightly fuzz list

To start fuzzing zip extraction:

cargo +nightly fuzz run fuzz_read

To start fuzzing zip creation:

cargo +nightly fuzz run fuzz_write