utils_box_archives/lib.rs
1//! # Summary
2//! A toolbox library that holds a useful collection of small unitilies written in Rust that make our life easier when writting Rust applications.
3//!
4//! # Utilities provided:
5//! ## Archives
6//! Extract files from Tar, Gz and Zip Files
7//!
8//! Mininal Example:
9//! ```ignore
10//! let archive: PathBuf = std::env::current_exe()
11//! .unwrap()
12//! .parent()
13//! .unwrap()
14//! .join("test_archive.tar.gz");
15//!
16//! let file: PathBuf = "treasure.hex".into();
17//!
18//! let destination: PathBuf = std::env::current_exe()
19//! .unwrap()
20//! .parent()
21//! .unwrap();
22//!
23//! archives::extract_file(archive, ArchiveType::Gz, file, destination).unwrap();
24//!
25//! ```
26//!
27
28pub mod archives;