mobad / rs-async-zip

An asynchronous ZIP archive reading/writing crate.

async_zip

An asynchronous ZIP archive reading/writing crate powered by tokio.

Features

• Support for Stored, Deflate, bzip2, LZMA, zstd, and xz compression methods.
• Various different reading approaches (seek, stream, filesystem, in-memory buffer, etc).
• Support for writing complete data (u8 slices) or streams using data descriptors.
• Aims for reasonable specification compliance.

Installation & Basic Usage

[dependencies]
async_zip = "0.0.7"

A (soon to be) extensive list of examples can be found under the /examples directory.

Reading

use tokio::{io::AsyncReadExt, fs::File};
use async_zip::read::seek::ZipFileReader;
...

let mut file = File::open("./Archive.zip").await.unwrap();
let mut zip = ZipFileReader::new(&mut file).await.unwrap();

let mut reader = zip.entry_reader(0).await.unwrap();
let txt = reader.read_to_string_crc().await.unwrap();

println!("{}", txt);

Writing

use async_zip::write::{EntryOptions, ZipFileWriter};
use async_zip::Compression;
use tokio::fs::File;
...

let mut file = File::create("foo.zip").await.unwrap();
let mut writer = ZipFileWriter::new(&mut file);

let data = b"This is an example file.";
let opts = EntryOptions::new(String::from("bar.txt"), Compression::Deflate);

writer.write_entry_whole(opts, data).await.unwrap();
writer.close().await.unwrap();

Contributions

Whilst I will be continuing to maintain this crate myself, reasonable specification compliance is a huge undertaking for a single individual. As such, contributions will always be encouraged and appreciated.

No contribution guidelines exist but additions should be developed with readability in mind, with appropriate comments, and make use of rustfmt.

Issues & Support

Whether you're wanting to report a bug you've come across during use of this crate or are seeking general help/assistance, please utilise the issues tracker and provide as much detail as possible (eg. recreation steps).

I try to respond to issues within a reasonable timeframe.