compiling the zip2 crate to wasm with the goal of compiling to luau through wasynth
46c2ae88d4
The primary goal of this commit is to enable this library to emit zip archives with symlinks while minimizing the surface area of the change to hopefully enable the PR to merge with minimal controversy. Today, it isn't possible to write symlinks with this library because there's no way to preserve the upper S_IFMT bits in the file mode bits because: * There's no way to set FileOptions.permissions with the S_IFLNK bits set (FileOptions.unix_permissions() throws away bits beyond 0o777). * Existing APIs for starting a "typed" (e.g. file or directory) entry automatically set the S_IFMT bits and could conflict with bits set on FileOptions.permissions. * The low-level, generic start_entry() function isn't public. When implementing this, I initially added a `FileOptions.unix_mode()` function to allow setting all 16 bits in the eventual external attributes u32. However, I quickly realized this wouldn't be enough because APIs like start_file() do things like `|= 0o100000`. So if we went this route, we'd need to make consumers of FileOptions.permissions aware of when they should or shouldn't touch the high bits beyond 0o777. I briefly thought about making FileOptions.permissions an enum with a variant to allow the st_mode bits to sail through unmodified. But this change seemed overly invasive, low level, and not very user-friendly. So the approach I decided on was to define a new add_symlink() API. It follows the pattern of add_directory() and provides an easy-to-use and opionated API around the addition of a special file type. I purposefully chose to not implement reading or extraction support for symlinks because a) I don't need the feature at the moment b) implementing symlink extraction in a way that works reliably on all platforms and doesn't have security issues is hard. I figured it was best to limit the scope of this change so this PR stands a good chance of being merged. Partially implements #77. |
||
|---|---|---|
| .github | ||
| benches | ||
| examples | ||
| src | ||
| tests | ||
| .gitignore | ||
| Cargo.toml | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
zip-rs
PSA: This version of the ZIP crate will not gain any new features, and will only be updated if major security issues are found.
Info
A zip library for rust which supports reading and writing of simple ZIP files.
Supported compression formats:
- stored (i.e. none)
- deflate
- bzip2
- zstd
Currently unsupported zip extensions:
- Encryption
- Multi-disk
Usage
With all default features:
[dependencies]
zip = "0.6.2"
Without the default features:
[dependencies]
zip = { version = "0.6.2", default-features = false }
The features available are:
aes-crypto: Enables decryption of files which were encrypted with AES. Supports AE-1 and AE-2 methods.deflate: Enables the deflate compression algorithm, which is the default for zip files.bzip2: Enables the BZip2 compression algorithm.time: Enables features using the time crate.zstd: Enables the Zstandard compression algorithm.
All of these are enabled by default.
MSRV
Our current Minimum Supported Rust Version is 1.54.0. When adding features, we will follow these guidelines:
- We will always support the latest four minor Rust versions. This gives you a 6 month window to upgrade your compiler.
- Any change to the MSRV will be accompanied with a minor version bump
- While the crate is pre-1.0, this will be a change to the PATCH version.
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.