Popularity
6.2
Growing
Activity
8.6
-
438
14
156

README

zip-rs

Build Status Crates.io version Discord

Documentation

PSA: This version of the ZIP crate will not gain any new features, and will only be updated if major security issues are found.

Info

A zip library for rust which supports reading and writing of simple ZIP files.

Supported compression formats:

  • stored (i.e. none)
  • deflate
  • bzip2
  • zstd

Currently unsupported zip extensions:

  • Encryption
  • Multi-disk

Usage

With all default features:

[dependencies]
zip = "0.6.2"

Without the default features:

[dependencies]
zip = { version = "0.6.2", default-features = false }

The features available are:

  • aes-crypto: Enables decryption of files which were encrypted with AES. Supports AE-1 and AE-2 methods.
  • deflate: Enables the deflate compression algorithm, which is the default for zip files.
  • bzip2: Enables the BZip2 compression algorithm.
  • time: Enables features using the time crate.
  • zstd: Enables the Zstandard compression algorithm.

All of these are enabled by default.

MSRV

Our current Minimum Supported Rust Version is 1.57.0. 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
    • While the crate is pre-1.0, this will be a change to the PATCH version.

Examples

See the [examples directory](examples) 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.

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