Crate async_zip

Source
Expand description

An asynchronous ZIP archive reading/writing crate.

§Features

  • A base implementation atop futures’s IO traits.
  • An extended implementation atop tokio’s IO traits.
  • Support for Stored, Deflate, bzip2, LZMA, zstd, and xz compression methods.
  • Various different reading approaches (seek, stream, filesystem, in-memory buffer).
  • Support for writing complete data (u8 slices) or stream writing using data descriptors.
  • Initial support for ZIP64 reading and writing.
  • Aims for reasonable specification compliance.

§Installation

[dependencies]
async_zip = { version = "0.0.17", features = ["full"] }

§Feature Flags

  • full - Enables all below features.
  • full-wasm - Enables all below features that are compatible with WASM.
  • chrono - Enables support for parsing dates via chrono.
  • tokio - Enables support for the tokio implementation module.
  • tokio-fs - Enables support for the tokio::fs reading module.
  • deflate - Enables support for the Deflate compression method.
  • bzip2 - Enables support for the bzip2 compression method.
  • lzma - Enables support for the LZMA compression method.
  • zstd - Enables support for the zstd compression method.
  • xz - Enables support for the xz compression method.

Read more.

Modules§

base
A base runtime-agnostic implementation using futures’s IO types.
error
A module which holds relevant error reporting structures/types.
tokio
A set of tokio-specific type aliases and features.

Structs§

StoredZipEntry
An immutable store of data about how a ZIP entry is stored within a specific archive.
ZipDateTime
A date and time stored as per the MS-DOS representation used by ZIP files.
ZipDateTimeBuilder
A builder for ZipDateTime.
ZipEntry
An immutable store of data about a ZIP entry.
ZipEntryBuilder
A builder for ZipEntry.
ZipFile
An immutable store of data about a ZIP file.
ZipFileBuilder
A builder for ZipFile.
ZipString
A string wrapper for handling different encodings.

Enums§

AttributeCompatibility
An attribute host compatibility supported by this crate.
Compression
A compression method supported by this crate.
DeflateOption
Level of compression data should be compressed with for deflate.
StringEncoding
A string encoding supported by this crate.