Initial support for tokio

.github/workflows/ci.yaml

@@ -21,7 +21,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macOS-latest, windows-latest]
         rustalias: [stable, nightly, msrv]
-        feature_flag: ["--all-features", "--no-default-features", ""]
+        feature_flag: ["--no-default-features --features sync_all", "--no-default-features --features tokio_all", "--no-default-features --features sync", "--no-default-features --features tokio", ""]
         include:
         - rustalias: stable
           rust: stable

Cargo.toml

@@ -18,6 +18,25 @@ edition = "2021"
 exclude = ["tests/**", "examples/**", ".github/**", "fuzz/**"]
 build = "src/build.rs"
 
+[package.metadata.docs.rs]
+features = [
+    "aes-crypto",
+    "bzip2",
+    "chrono",
+    "deflate",
+    "deflate64",
+    "deflate",
+    "deflate-zlib",
+    "deflate-zlib-ng",
+    "lzma",
+    "time",
+    "zstd",
+]
+# Can be enabled when <https://github.com/zopfli-rs/zopfli/issues/42> is fixed
+# all-features = true
+no-default-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [workspace.dependencies]
 time = { version = "0.3.36", default-features = false }
 
@@ -43,6 +62,8 @@ zstd = { version = "0.13.1", optional = true, default-features = false }
 zopfli = { version = "0.8.0", optional = true }
 deflate64 = { version = "0.1.8", optional = true }
 lzma-rs = { version = "0.3.0", default-features = false, optional = true }
+true = { version = "0.1.0", optional = true }
+tokio = { version = "1.37.0", optional = true }
 
 [target.'cfg(any(all(target_arch = "arm", target_pointer_width = "32"), target_arch = "mips", target_arch = "powerpc"))'.dependencies]
 crossbeam-utils = "0.8.19"
@@ -68,11 +89,14 @@ deflate = ["flate2/rust_backend", "_deflate-any"]
 
 # DEPRECATED: previously enabled `flate2/miniz_oxide` which is equivalent to `flate2/rust_backend`
 deflate-miniz = ["deflate", "_deflate-any"]
-
 deflate-zlib = ["flate2/zlib", "_deflate-any"]
 deflate-zlib-ng = ["flate2/zlib-ng", "_deflate-any"]
 deflate-zopfli = ["zopfli", "_deflate-any"]
 lzma = ["lzma-rs/stream"]
+sync = []
+sync_all = ["aes-crypto", "chrono", "deflate", "deflate-miniz", "deflate-zlib", "deflate-zlib-ng", "deflate-zopfli", "lzma", "sync","time"]
+tokio_all = ["aes-crypto", "chrono", "deflate", "deflate-miniz", "deflate-zlib", "deflate-zlib-ng", "deflate-zopfli", "lzma","time", "tokio"]
+tokio = ["tokio/io-util"]
 unreserved = []
 default = [
     "aes-crypto",
@@ -82,6 +106,7 @@ default = [
     "deflate-zlib-ng",
     "deflate-zopfli",
     "lzma",
+    "sync",
     "time",
     "zstd",
 ]

src/build.rs

@@ -4,4 +4,9 @@ fn main() {
     if var("CARGO_FEATURE_DEFLATE_MINIZ").is_ok() && var("CARGO_FEATURE__ALL_FEATURES").is_err() {
         println!("cargo:warning=Feature `deflate-miniz` is deprecated; replace it with `deflate`");
     }
+    #[cfg(not(any(feature = "sync", feature = "tokio")))]
+    compile_error!("Missing Required feature");
+
+    #[cfg(all(feature = "sync", feature = "tokio"))]
+    compile_error!("The features sync and tokio cannot be used together")
 }

src/lib.rs

@@ -25,6 +25,7 @@
 //! | ZipCrypto deprecated encryption | ✅ | ✅ |
 //!
 //!
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_docs)]
 #![allow(unexpected_cfgs)] // Needed for cfg(fuzzing) on nightly as of 2024-05-06
 pub use crate::compression::{CompressionMethod, SUPPORTED_COMPRESSION_METHODS};

src/read.rs

@@ -1,8 +1,13 @@
 //! Types for reading ZIP archives
 
 /// Module for code with synchronous logic
+#[cfg(feature = "sync")]
 pub mod sync;
 
+/// Module for code with asynchronous logic
+#[cfg(feature = "tokio")]
+pub mod tokio;
+
 #[cfg(feature = "aes-crypto")]
 use crate::{aes::AesReaderValid, types::AesVendorVersion};
 use crate::{crc32::Crc32Reader, types::ZipFileData, zipcrypto::ZipCryptoReaderValid};
@@ -121,7 +126,6 @@ pub(crate) struct CentralDirectoryInfo {
 mod test {
     use crate::ZipArchive;
     use std::io::Cursor;
-    use tempdir::TempDir;
 
     #[test]
     fn invalid_offset() {
@@ -316,16 +320,4 @@ mod test {
         let mut file = reader.by_index(0).unwrap();
         assert_eq!(file.read(&mut decompressed).unwrap(), 12);
     }
-
-    #[test]
-    fn test_is_symlink() -> std::io::Result<()> {
-        let mut v = Vec::new();
-        v.extend_from_slice(include_bytes!("../tests/data/symlink.zip"));
-        let mut reader = ZipArchive::new(Cursor::new(v)).unwrap();
-        assert!(reader.by_index(0).unwrap().is_symlink());
-        let tempdir = TempDir::new("test_is_symlink")?;
-        reader.extract(&tempdir).unwrap();
-        assert!(tempdir.path().join("bar").is_symlink());
-        Ok(())
-    }
 }

src/read/stream.rs

@@ -9,6 +9,7 @@ use std::fs;
 use std::io::{self, Read};
 use std::path::{Path, PathBuf};
 
+#[cfg(feature = "sync")]
 use super::sync::{central_header_to_zip_file_inner, read_zipfile_from_stream};
 
 /// Stream decoder for zip.