blob: 330d9affa75adf4cb48a61a8a0d0d65c00cc5c3b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
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 (optional, enabled by default)
Currently unsupported zip extensions:
* Encryption
* Multi-disk
We aim to support rust versions 1.20+.
Usage
-----
With all default features:
```toml
[dependencies]
zip = "0.4"
```
Without the default features:
```toml
[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](https://github.com/Frommi/miniz_oxide)
* `deflate-miniz` uses [miniz](https://github.com/richgel999/miniz)
* `deflate-zlib` uses zlib
For example:
```toml
[dependencies]
zip = { version = "0.4", features = ["deflate-zlib"], default-features = false }
```
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.
|
