Skip to main content

orbok_fs/
lib.rs

1//! # orbok-fs
2//!
3//! The safe file-access layer:
4//! - [`path_guard`] — backend-enforced source membership and policy
5//!   validation (RFC-003 §8): no file is read unless it passes;
6//! - [`policy`] — compiled source policies (include/exclude, hidden,
7//!   symlink, size, supported types);
8//! - [`sensitive`] — sensitive-directory warnings (RFC-003 §7);
9//! - [`scanner`] — file discovery and change detection (RFC-004).
10//!
11//! The GUI never calls into this crate; it goes through `orbok-core`
12//! service interfaces (RFC-027 boundary rule).
13
14pub mod hashing;
15pub mod path_guard;
16pub mod policy;
17pub mod scanner;
18pub mod sensitive;
19
20#[cfg(test)]
21mod tests;
22
23pub use path_guard::{GuardedSource, PathGuard, ValidatedPath};
24pub use policy::{CompiledPolicy, FileTypeClass};
25pub use scanner::{ScanOutcomeKind, ScanRequest, ScanSummary, Scanner};
26pub use sensitive::sensitive_warning;