diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 14:29:10 +0000 |
commit | 2aa4a82499d4becd2284cdb482213d541b8804dd (patch) | |
tree | b80bf8bf13c3766139fbacc530efd0dd9d54394c /third_party/rust/zip/README.md | |
parent | Initial commit. (diff) | |
download | firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.tar.xz firefox-2aa4a82499d4becd2284cdb482213d541b8804dd.zip |
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/zip/README.md')
-rw-r--r-- | third_party/rust/zip/README.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/third_party/rust/zip/README.md b/third_party/rust/zip/README.md new file mode 100644 index 0000000000..330d9affa7 --- /dev/null +++ b/third_party/rust/zip/README.md @@ -0,0 +1,65 @@ +zip-rs +====== + +[![Build Status](https://travis-ci.org/mvdnes/zip-rs.svg?branch=master)](https://travis-ci.org/mvdnes/zip-rs) +[![Build status](https://ci.appveyor.com/api/projects/status/gsnpqcodg19iu253/branch/master?svg=true)](https://ci.appveyor.com/project/mvdnes/zip-rs/branch/master) +[![Crates.io version](https://img.shields.io/crates/v/zip.svg)](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. |