compress-tools

Dependencies

You must have libarchive, 3.2.0 or newer, properly installed on your system in order to use this. If building on *nix and Windows GNU systems, pkg-config is used to locate the libarchive; on Windows MSVC, vcpkg will be used to locating the libarchive.

Typical install:

• Debian/Ubuntu: apt install libarchive-dev pkg-config
• macOS (Homebrew): brew install libarchive pkg-config (libarchive is

• Windows MSVC: vcpkg install libarchive

Install

[dependencies]
compress-tools = "0.16"

To enable async support backed by tokio:

[dependencies]
compress-tools = { version = "0.16", features = ["tokio_support"] }

See Feature flags for the full list.

Upgrading to 0.16

0.16.0 introduces a few breaking changes. See CHANGES.md for the complete list; the highlights are:

• Archive entry points now reject non-archive input.

• Async entry points require AsyncSeek. The async variants of

• Error::Extraction changed shape. It now carries a details

• New Error::UnsupportedZipCompression variant. ZIP archives

• MSRV raised to 1.82.0 (was 1.65.0). Older toolchains will fail

Features

This crate is capable of extracting:

• compressed files
• archive files
• a single file from an archive

Extract an entire archive

use compress_tools::*;
use std::fs::File;
use std::path::Path;
let mut source = File::open("tree.tar.gz")?; let dest = Path::new("/tmp/dest");
uncompress_archive(&mut source, &dest, Ownership::Preserve)?;

Extract a single file from an archive

use compresstools::uncompressarchive_file;
use std::fs::File;
let mut source = File::open("tree.tar.gz")?; let mut target = File::create("/tmp/README.md")?;
uncompressarchivefile(&mut source, &mut target, "tree/README.md")?;

Iterate over archive entries

use compress_tools::{ArchiveContents, ArchiveIteratorBuilder};
use std::fs::File;
let source = File::open("tree.tar.gz")?; let iter = ArchiveIteratorBuilder::new(source).build()?;
for content in iter {     match content {         ArchiveContents::StartOfEntry(name, _stat) => println!("entry: {name}"),         ArchiveContents::DataChunk(_bytes) => { / stream the entry body / }         ArchiveContents::EndOfEntry => {}         ArchiveContents::Err(e) => return Err(e.into()),     } }

List entries with sizes

use compresstools::listarchive_entries;
use std::fs::File;
let mut source = File::open("tree.tar")?; for entry in listarchiveentries(&mut source)? {     println!("{}: {} bytes", entry.path, entry.size); }

Asynchronous iteration (tokio)

Requires the tokio_support feature.

use compresstools::tokiosupport::ArchiveIteratorBuilder;
use compress_tools::ArchiveContents;
use futures_util::StreamExt;
use tokio::fs::File;
#[tokio::main] async fn main() -> Result<(), Box<dyn std::error::Error>> {     let source = File::open("tree.tar.gz").await?;     let mut iter = ArchiveIteratorBuilder::new(source).build();
while let Some(content) = iter.next().await {         if let ArchiveContents::StartOfEntry(name, _stat) = content {             println!("entry: {name}");         }     }     Ok(()) }

Password-protected ZIP archives

use compress_tools::{ArchiveIteratorBuilder, ArchivePassword};
use std::fs::File;
let source = File::open("secret.zip")?; let iter = ArchiveIteratorBuilder::new(source)     .with_password(ArchivePassword::new("<your password>")?)     .build()?;
for _content in iter {     // ... }

Feature flags

| Flag | Purpose | | ---- | ------- | | async_support | Base, executor-agnostic async primitives. | | futuressupport | asyncsupport plus blocking integration for the futures ecosystem. | | tokiosupport | asyncsupport plus tokio / tokio-util integration. | | static | Statically link all bundled archive libraries and enable the default Windows imports. | | staticb2, staticlz4, staticzstd, staticlzma, staticbz2, staticz, static_xml2 | Selective static linking, one per bundled dependency. | | winuser32, wincrypt32, winadvapi32, winxmllite | Windows system import libraries (all enabled by default). |

License

Licensed under either of

* Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0) * MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.