hadris-ntfs 2.1.0

A library for reading NTFS filesystems
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

//! # hadris-ntfs
//!
//! A `no_std`-compatible library for reading NTFS filesystems (read-only).
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use std::fs::File;
//! use hadris_ntfs::sync::{NtfsFs, NtfsFsReadExt};
//!
//! let file = File::open("disk.img").unwrap();
//! let fs = NtfsFs::open(file).unwrap();
//! let root = fs.root_dir();
//! let entries = root.entries().unwrap();
//! for entry in &entries {
//!     println!("{} ({})", entry.name(), if entry.is_directory() { "dir" } else { "file" });
//! }
//! ```
//!
//! ## Feature Flags
//!
//! | Feature  | Default | Description |
//! |----------|---------|-------------|
//! | `std`    | Yes     | Standard library support (enables `alloc`) |
//! | `alloc`  | Yes     | Heap allocation without full std |
//! | `sync`   | Yes     | Synchronous API via `hadris-io` sync traits |
//! | `async`  | No      | Asynchronous API via `hadris-io` async traits |
//! | `read`   | Yes     | Read operations (requires `alloc`) |
//!
//! ## Dual Sync/Async Architecture
//!
//! This crate provides both synchronous and asynchronous APIs through
//! a compile-time code transformation system. The same implementation
//! source is compiled twice:
//!
//! - **`sync`** module: synchronous API (enabled by the `sync` feature)
//! - **`async`** module: asynchronous API (enabled by `async` feature)
//!
//! With the default `sync` and `read` features, the synchronous API types are
//! re-exported at the crate root for convenience. The `std` feature does not
//! select an I/O mode.
//!
//! ## Supported Scope
//!
//! The reader supports validated boot geometry, update-sequence-protected
//! MFT/index records, resident and non-resident unnamed data, sparse runs,
//! initialized-size zero filling, directory index allocation/bitmaps, NTFS
//! filename namespaces, and `$UpCase` collation.
//!
//! It does not yet resolve `$ATTRIBUTE_LIST` extension records, recover from
//! `$MFTMirr`, decode compressed or encrypted streams, expose named alternate
//! data streams, or interpret reparse points. See the internal compliance
//! matrix in `docs/spec-coverage.md`.

#![no_std]
#![allow(async_fn_in_trait)]
#![allow(clippy::duplicate_mod)]
#![deny(missing_docs)]

#[cfg(feature = "std")]
extern crate std;

#[cfg(feature = "alloc")]
extern crate alloc;

// ---------------------------------------------------------------------------
// Shared types (compiled once, not duplicated by sync/async modules)
// ---------------------------------------------------------------------------

#[cfg(feature = "read")]
pub mod attr;
pub mod error;
pub mod raw;

// ---------------------------------------------------------------------------
// Sync module
// ---------------------------------------------------------------------------

#[cfg(all(feature = "sync", feature = "read"))]
#[path = ""]
pub mod sync {
    //! Synchronous NTFS filesystem API.
    //!
    //! All I/O operations use synchronous `Read`/`Seek` traits.

    pub use hadris_io::Result as IoResult;
    pub use hadris_io::sync::{Parsable, Read, ReadExt, Seek};
    pub use hadris_io::{Error, ErrorKind, SeekFrom};

    macro_rules! io_transform {
        ($($item:tt)*) => { hadris_macros::strip_async!{ $($item)* } };
    }

    #[allow(unused_macros)]
    macro_rules! sync_only {
        ($($item:tt)*) => { $($item)* };
    }

    #[allow(unused_macros)]
    macro_rules! async_only {
        ($($item:tt)*) => {};
    }

    #[path = "."]
    mod __inner {
        pub mod dir;
        pub mod fs;
        pub mod io;
        pub mod read;
    }
    pub use __inner::*;

    pub use __inner::dir::{NtfsDir, NtfsEntry};
    pub use __inner::fs::NtfsFs;
    pub use __inner::read::{FileReader, NtfsFsReadExt};
}

// ---------------------------------------------------------------------------
// Async module
// ---------------------------------------------------------------------------

#[cfg(all(feature = "async", feature = "read"))]
#[path = ""]
pub mod r#async {
    //! Asynchronous NTFS filesystem API.
    //!
    //! All I/O operations use async `Read`/`Seek` traits.

    pub use hadris_io::Result as IoResult;
    pub use hadris_io::r#async::{Parsable, Read, ReadExt, Seek};
    pub use hadris_io::{Error, ErrorKind, SeekFrom};

    macro_rules! io_transform {
        ($($item:tt)*) => { $($item)* };
    }

    #[allow(unused_macros)]
    macro_rules! sync_only {
        ($($item:tt)*) => {};
    }

    #[allow(unused_macros)]
    macro_rules! async_only {
        ($($item:tt)*) => { $($item)* };
    }

    #[path = "."]
    mod __inner {
        pub mod dir;
        pub mod fs;
        pub mod io;
        pub mod read;
    }
    pub use __inner::*;
}

// ---------------------------------------------------------------------------
// Default re-exports (sync)
// ---------------------------------------------------------------------------

#[cfg(all(feature = "sync", feature = "read"))]
pub use sync::*;

pub use error::{NtfsError, Result};
pub use raw::*;