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

//! Extract files from InstallShield Z archives.
//!
//! This crate can open and extract files from [InstallShield Z
//! archives][z]. This archive format is used by version 3 of
//! InstallShield.
//!
//!  [z]: http://fileformats.archiveteam.org/wiki/InstallShield_Z
//!
//! # Command Line
//!
//! This crate comes with a simple command line tool for extracting
//! and inspecting Z archives.
//!
//! ```bash
//! unshield list src/examples/demo.z
//! unshield extract src/examples/demo.z demo-out
//! ```
//! # Examples
//!
//! Anything that implements [`Read`][Read] and [`Seek`][Seek] can be
//! read as an archive. Most commonly, this will be a [`File`][File].
//!
//!  [Read]: https://doc.rust-lang.org/std/io/trait.Read.html
//!  [Seek]: https://doc.rust-lang.org/std/io/trait.Seek.html
//!  [File]: https://doc.rust-lang.org/std/io/struct.File.html
//!
//! ```
//! # fn main() -> explode::Result<()> {
//! let mut some_file = std::fs::File::open("src/examples/demo.z")?;
//! let mut ar = unshield::Archive::new(some_file)?;
//!
//! let data = ar.load("subdir\\test.txt")?;
//!
//! for fileinfo in ar.list() {
//!     println!("{}", fileinfo.path);
//! }
//! # assert_eq!(data, b"fnord");
//! # Ok(()) }
//! ```

// we want feature tags in documentation on docsrs
#![cfg_attr(docsrs, feature(doc_cfg))]

mod archive;
mod examples;
mod format;

pub use archive::Archive;
pub use format::FileInfo;

#[cfg(feature = "async")]
mod asyncarchive;
#[cfg(feature = "async")]
pub use asyncarchive::AsyncArchive;