decompress 0.5.0

Extracting archives made easy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100


# Decompress

[<img alt="github" src="https://img.shields.io/badge/github-rusty_ferris_club/decompress-8dagcb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/rusty-ferris-club/decompress)
[<img alt="crates.io" src="https://img.shields.io/crates/v/decompress.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/decompress)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-decompress-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/decompress)
[<img alt="build status" src="https://img.shields.io/github/workflow/status/rusty-ferris-club/decompress/Build/master?style=for-the-badge" height="20">](https://github.com/rusty-ferris-club/decompress/actions?query=branch%3Amaster)

A library that supports decompression of archives in multiple formats, inspired by ergonomics from Node's [decompress](https://github.com/kevva/decompress).

* Includes a default stack of decompressors supporting: `zip`, `tar`, `tar.gz`, `tar.bz2`, `tar.xz`, `tar.zst` (zstd compression), `ar` (Unix Archive)
* Build your own decompressors and add them
* Compose a custom stack (exclude compressors, respond to different file extensions)
* Use `cargo` features to avoid compiling formats you don't need

# Dependency

```toml
[dependencies]
decompress = "0.1.0"
```


# Usage

Default use:

```rust
decompress::decompress(archive, to, &ExtractOpts::default());
```

Strip the first component of all paths in the archive (for when you have a wrapper folder you don't need):

```rust
decompress::decompress(archive, to, &ExtractOpts{ strip: 1 });
```

A micro optimization:

```rust
let decompressor = decompress::Decompress::default()
// use decompressor
// decompressor.decompress(...)
```

Build your own stack:

```rust
use regex::Regex;
let decompressor = decompress::Decompress::build(vec![decompressors::zip::Zip::build(Some(
    Regex::new(r".*").unwrap(),
))]);
// use decompressor
// decompressor.decompress(...)
```

It's also possible to filter unwanted files, similar to [nodejs decompress](https://github.com/kevva/decompress)
```rust
let decompressor = decompress::Decompress::default();
let res = decompressor.decompress(
    archive,
    to,
    &ExtractOptsBuilder::default()
        .strip(strip)
        .filter(|path| {
            if let Some(path) = path.to_str() {
            return path.ends_with("abc.sh");
            }
            false
        })
        .build()
        .unwrap(),
);
```

Mapping paths is also supported
```rust
let decompressor = decompress::Decompress::default();
let res = decompressor.decompress(
    archive,
    to,
    &ExtractOptsBuilder::default()
        .strip(strip)
        .map(|path| {
            let mut path = path.to_path_buf();
            path.set_file_name(format!(
                "abc-{}",
                path.file_name().unwrap().to_str().unwrap()
            ));
            path.into()
        })
        .build()
        .unwrap(),
);
```


# Copyright

Copyright (c) 2022 [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.