zip-rs

Documentation

Info

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

Supported compression formats:

• stored (i.e. none)
• deflate
• bzip2 (optional, enabled by default)

Currently unsupported zip extensions:

• Encryption
• Multi-disk

We aim to support rust versions 1.20+.

Usage

With all default features:

[dependencies]
zip = "0.4"

Without the default features:

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

You can further control the backend of deflate compression method with these features:

• deflate (enabled by default) uses miniz_oxide
• deflate-miniz uses miniz
• deflate-zlib uses zlib

For example:

[dependencies]
zip = { version = "0.4", features = ["deflate-zlib"], default-features = false }

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.