async_zip/
lib.rs

1// Copyright (c) 2021-2023 Harry [Majored] [hello@majored.pw]
2// MIT License (https://github.com/Majored/rs-async-zip/blob/main/LICENSE)
3
4// Document all features on docs.rs
5#![cfg_attr(docsrs, feature(doc_cfg))]
6
7//! An asynchronous ZIP archive reading/writing crate.
8//!
9//! ## Features
10//! - A base implementation atop `futures`'s IO traits.
11//! - An extended implementation atop `tokio`'s IO traits.
12//! - Support for Stored, Deflate, bzip2, LZMA, zstd, and xz compression methods.
13//! - Various different reading approaches (seek, stream, filesystem, in-memory buffer).
14//! - Support for writing complete data (u8 slices) or stream writing using data descriptors.
15//! - Initial support for ZIP64 reading and writing.
16//! - Aims for reasonable [specification](https://github.com/Majored/rs-async-zip/blob/main/SPECIFICATION.md) compliance.
17//!
18//! ## Installation
19//!
20//! ```toml
21//! [dependencies]
22//! async_zip = { version = "0.0.17", features = ["full"] }
23//! ```
24//!
25//! ### Feature Flags
26//! - `full` - Enables all below features.
27//! - `full-wasm` - Enables all below features that are compatible with WASM.
28//! - `tokio` - Enables support for the `tokio` implementation module.
29//! - `tokio-fs` - Enables support for the `tokio::fs` reading module.
30//! - `deflate` - Enables support for the Deflate compression method.
31//! - `bzip2` - Enables support for the bzip2 compression method.
32//! - `lzma` - Enables support for the LZMA compression method.
33//! - `zstd` - Enables support for the zstd compression method.
34//! - `xz` - Enables support for the xz compression method.
35//!
36//! [Read more.](https://github.com/Majored/rs-async-zip)
37
38pub mod base;
39pub mod error;
40
41#[cfg(feature = "tokio")]
42pub mod tokio;
43
44pub(crate) mod date;
45pub(crate) mod entry;
46pub(crate) mod file;
47pub(crate) mod spec;
48pub(crate) mod string;
49pub(crate) mod utils;
50
51#[cfg(test)]
52pub(crate) mod tests;
53
54pub use crate::spec::attribute::AttributeCompatibility;
55pub use crate::spec::compression::{Compression, DeflateOption};
56
57pub use crate::date::{builder::ZipDateTimeBuilder, ZipDateTime};
58pub use crate::entry::{builder::ZipEntryBuilder, StoredZipEntry, ZipEntry};
59pub use crate::file::{builder::ZipFileBuilder, ZipFile};
60
61pub use crate::string::{StringEncoding, ZipString};
async_zip/lib.rs

async_zip/
lib.rs
