zff/
mod.rs

1#![forbid(unsafe_code)]
2#![deny(missing_docs)]
3//! This crate provides the reference implementation of the forensic file format Zff.
4//! Zff is a new file format for forensic images, as an alternative to EWF and AFF.
5//! Zff is focused on speed and security. If you want to learn more about ZFF, visit [https://github.com/ph0llux/zff](https://github.com/ph0llux/zff).
6
7// - modules
8/// This module contains several structs and methods to create and read zff images in version 1.
9pub mod version1;
10/// This module contains several structs and methods to create, read and extend zff container in version 2.
11pub mod version2;
12/// This module contains all constants, used in this crate.
13pub mod constants;
14/// This module contains all header, could be found in the zff specification (header version 1 and header version 2).
15pub mod header;
16/// This module contains all footer, could be found in the zff specification (footer version 1 and footer version 2).
17pub mod footer;
18mod hashing;
19mod compression;
20mod encryption;
21mod traits;
22mod error;
23mod signatures;
24mod file_extension;
25mod io;
26
27// - re-exports
28pub use hashing::*;
29pub use compression::*;
30pub use encryption::*;
31pub use error::*;
32pub use signatures::*;
33pub use traits::*;
34pub use file_extension::*;
35use io::*;
36use constants::*;
37//
38pub use version2::*;
39pub use version2::io::*;
40
41// - types
42/// Result for std::result::Result<T, ZffError>.
43pub type Result<T> = std::result::Result<T, ZffError>;