# [vfs]-[zip]: Virtual FileSystem abstractions for ZIP files

<!-- [![Build status](https://ci.appveyor.com/api/projects/status/nyvlrelifcyjc1l1?svg=true)](https://ci.appveyor.com/project/MaulingMonkey/vfs-zip) -->
[![GitHub](https://img.shields.io/github/stars/MaulingMonkey/vfs-zip.svg?label=GitHub&style=social)](https://github.com/MaulingMonkey/vfs-zip)
[![crates.io](https://img.shields.io/crates/v/vfs-zip.svg)](https://crates.io/crates/vfs-zip)
[![docs.rs](https://docs.rs/vfs-zip/badge.svg)](https://docs.rs/vfs-zip)
[![%23![forbid(unsafe_code)]](https://img.shields.io/github/search/MaulingMonkey/vfs-zip/unsafe%2bextension%3Ars?color=green&label=%23![forbid(unsafe_code)])](https://github.com/MaulingMonkey/vfs-zip/search?q=forbid%28unsafe_code%29+extension%3Ars)
[![rust: 1.34.0+](https://img.shields.io/badge/rust-1.34.0%2B-yellow.svg)](https://gist.github.com/MaulingMonkey/c81a9f18811079f19326dac4daa5a359#minimum-supported-rust-versions-msrv)
[![License](https://img.shields.io/crates/l/vfs-zip.svg)](https://github.com/MaulingMonkey/vfs-zip)
<!-- [![dependency status](https://deps.rs/repo/github/MaulingMonkey/vfs-zip/status.svg)](https://deps.rs/repo/github/MaulingMonkey/vfs-zip) -->

Currently this just bridges [vfs] and [zip].
Alternate VFS abstractions may be added in the future.
Caveats:

1.  [vfs] 0.4 lacks async interfaces, making it useless for browser targets.
2.  [zip] isn't amenable to re-entrant access.  This leads to Mutex spam, and
    forces open_file to copy/read the whole file up front.



<h2 name="features">Features</h2>

| Feature       | Description |
| ------------- | ----------- |
| **default**   |
| vfs04         | [vfs] = "[0.4.x](http://docs.rs/vfs/0.4)" interop
| zip-deflate   | "zip/deflate" (de)compression support
| zip-bzip2     | "zip/bzip2" (de)compression support
| **(opt-in)**  |
| zip-time      | "zip/time" write timestamps when creating zip archives



<h2 name="unsafe-code">Unsafe Code</h2>

Crate uses <code>[#![forbid(unsafe_code)]](https://github.com/MaulingMonkey/vfs-zip/search?q=forbid%28unsafe_code%29+extension%3Ars)</code>.
However, indirect dependencies do contain some `unsafe` - including, but perhaps not limited to:

| crate     | version |
| --------- | ------- |
| bzip2     | 0.3.3
| crc32fast | 1.2.0
| flat2     | 1.0.14
| syn       | 1.0.39
| time      | 0.1.44
| winapi    | 0.3.9



<h2 name="msrv">MSRV (Minimum Supported Rust Version)</h2>

Currently 1.34.0...ish.
*   [zip] 0.5.6 has a [MSRV of 1.34.0](https://github.com/mvdnes/zip-rs/blob/62dc406/README.md#msrv).
    However, zip's MSRV policy allows 0.5.7 to bump this, and `vfs-zip` does not pin zip to this version.
*   [vfs] 0.4.0 has a [MSRV of 1.32.0](https://github.com/manuel-woelker/rust-vfs/blob/c34f4ca/README.md#040-2020-08-13).
    However, it has no clear policy for when MSRV can be bumped.
*   Not all indirect dependencies have MSRV policies.  For example, I've already
    pinned flate2 to "<1.0.16" since "1.0.16" broke 1.34.0 with "extern crate alloc;"



<h2 name="license">License</h2>

Licensed under either of

* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.



<h2 name="license">Contribution</h2>

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.



[vfs]:          https://lib.rs/crates/vfs
[zip]:          https://lib.rs/crates/zip