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//!
31//! Compression features for `deflate`, `bzip2`, `lzma`, `zstd`, and `xz` follow the same pattern:
32//! - `foo` enables both reading and writing (equivalent to `foo-read` and `foo-write`).
33//! - `foo-read` enables reading without including the encoder in this crate's writers.
34//! - `foo-write` enables writing without including the decoder in this crate's readers.
35//!
36//! `deflate64` is an alias for `deflate64-read`. Deflate64 writing is not supported.
37//! Stored entries can always be read and written.
38//!
39//! [Read more.](https://github.com/Majored/rs-async-zip)
40
41pub mod base;
42pub mod error;
43
44#[cfg(feature = "tokio")]
45pub mod tokio;
46
47pub(crate) mod date;
48pub(crate) mod entry;
49pub(crate) mod file;
50pub(crate) mod spec;
51pub(crate) mod string;
52pub(crate) mod utils;
53
54#[cfg(test)]
55pub(crate) mod tests;
56
57pub use crate::spec::attribute::AttributeCompatibility;
58pub use crate::spec::compression::{Compression, DeflateOption};
59
60pub use crate::date::{builder::ZipDateTimeBuilder, ZipDateTime};
61pub use crate::entry::{builder::ZipEntryBuilder, StoredZipEntry, ZipEntry};
62pub use crate::file::{builder::ZipFileBuilder, ZipFile};
63
64pub use crate::string::{StringEncoding, ZipString};
async_zip/lib.rs

async_zip/
lib.rs
