hadris 2.0.0-rc.3

A unified Rust storage toolkit for filesystems, partitions, archives, and disk images
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

//! # Hadris
//!
//! **The Rust storage stack.**
//!
//! Hadris is a pure Rust toolkit for block devices, partition tables,
//! filesystems, archives, and disk images. Its feature model supports desktop
//! applications and `no_std` bootloaders, kernels, firmware, and embedded
//! systems.
//!
//! The umbrella crate groups the individual libraries by storage access model:
//!
//! - [`block`] — block filesystems and partition tables
//! - [`optical`] — optical filesystems and disc image composition
//! - [`archive`] — sequential archive formats
//! - [`path`] — lexical virtual-path parsing and normalization
//! - [`fixed`] — fixed-capacity byte and text types
//!
//! # Feature flags
//!
//! Leaf features (`storage`, `fat`, `part`, `iso`, `udf`, `cd`, and `cpio`) enable one
//! library at a time. The `block`, `optical`, and `archive` features enable all
//! libraries in their respective category. Platform (`std`, `alloc`), I/O mode
//! (`sync`, `async`), and capability (`read`, `write`) features are forwarded
//! independently to enabled leaves. The default set is the hosted synchronous
//! read/write configuration with `fat`, `iso`, and `cpio`.
//!
//! Hybrid CD image creation is currently sync-only. Enabling `cd`—directly or
//! through `optical`—therefore enables the CD writer's sync API, even when the
//! umbrella `async` feature is also selected. ISO and UDF still expose their
//! async modules in that configuration.
//!
//! # Quick start
//!
//! ```rust,no_run
//! use hadris::optical::iso::sync::IsoImage;
//!
//! let file = std::fs::File::open("image.iso").unwrap();
//! let iso = IsoImage::open(file).unwrap();
//! let pvd = iso.read_pvd().unwrap();
//! println!("Volume: {}", pvd.volume_identifier);
//! ```

#![deny(missing_docs)]

/// Block-oriented storage, filesystems, and disk-layout formats.
#[cfg(any(feature = "storage", feature = "fat", feature = "part"))]
pub use hadris_block as block;

/// Optical filesystems and disc-image composition.
#[cfg(any(feature = "iso", feature = "udf", feature = "cd"))]
pub use hadris_optical as optical;

/// Sequential archive formats.
#[cfg(feature = "cpio")]
pub use hadris_archive as archive;

/// Lexical virtual-path utilities.
#[cfg(feature = "path")]
pub use hadris_path as path;

/// Fixed-capacity byte and text types.
#[cfg(feature = "fixed")]
pub use hadris_fixed as fixed;