3d61d9cd8a
Changes include: * Switched to a different deflate (de)compressor * New DateTime api, removing default dependencies on time and msdos_time
61 lines
1.5 KiB
Markdown
61 lines
1.5 KiB
Markdown
zip-rs
|
|
======
|
|
|
|
[](https://travis-ci.org/mvdnes/zip-rs)
|
|
[](https://ci.appveyor.com/project/mvdnes/zip-rs/branch/master)
|
|
[](https://crates.io/crates/zip)
|
|
|
|
[Documentation](http://mvdnes.github.io/rust-docs/zip-rs/zip/index.html)
|
|
|
|
Info
|
|
----
|
|
|
|
A zip library for rust which supports reading and writing of simple ZIP files.
|
|
|
|
Supported compression formats:
|
|
|
|
* stored (i.e. none)
|
|
* deflate
|
|
* bzip2
|
|
|
|
Currently unsupported zip extensions:
|
|
|
|
* Encryption
|
|
* Multi-disk
|
|
|
|
We aim to support rust versions 1.20+.
|
|
|
|
Usage
|
|
-----
|
|
|
|
With all default features:
|
|
|
|
```toml
|
|
[dependencies]
|
|
zip = "0.5"
|
|
```
|
|
|
|
Without the default features:
|
|
|
|
```toml
|
|
[dependencies]
|
|
zip = { version = "0.5", default-features = false }
|
|
```
|
|
|
|
The features available are:
|
|
|
|
* `deflate`: Enables the deflate compression algorithm, which is the default for zipfiles
|
|
* `bzip2`: Enables the BZip2 compression algorithm.
|
|
* `time`: Enables features using the [time](https://github.com/rust-lang-deprecated/time) crate.
|
|
|
|
All of these are enabled by default.
|
|
|
|
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](https://github.com/BurntSushi/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.
|