Adding `arkiv` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add arkiv

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

arkiv = "0.7.0"

The arkiv library will be automatically available globally. Read the arkiv library documentation.

Back to the crate overview.

Readme

Arkiv

Arkiv is a convenience library to download, open, consult and extract archives of various format through a single consistent interface.

Supported Formats

sample.zip (requires the zip feature).
sample.tar (requires the tar feature).
sample.tgz or sample.tar.gz (requires tar and gzip features).
sample.tar.xz (requires tar and xz features).
sample.tar.bz2 (requires tar and bzip features).
sample.tar.zstd or sample.tar.zst (requires tar and zstd features).

Usage

use arkiv::{Result, Archive};

fn main() -> Result<()> {
    // open the archive from a local file
    let mut archive = arkiv::Archive::open("path/to/archive.tar.xz")?;

    // or download it over HTTP(S) - requires the `download` feature.
    #[cfg(feature="download")]
    let mut archive = {
        let url = "https://github.com/meuter/arkiv-rs/raw/main/tests/sample/sample.tar.zstd";
        arkiv::Archive::download(url)?
    };

    // iterate over entries
    for entry in archive.entries_iter()? {
        let entry = entry?;
        println!("{} {}", entry.size(), entry.path().display());
    }

    // extract the archive (perserves permission on unix targets)
    archive.unpack("/tmp/")?;

    Ok(())
}

Adding arkiv library as a dependency

Adding `arkiv` library as a dependency