Skip to main content

Crate orbok_fs

Crate orbok_fs 

Source
Expand description

§orbok-fs

The safe file-access layer:

  • path_guard — backend-enforced source membership and policy validation (RFC-003 §8): no file is read unless it passes;
  • policy — compiled source policies (include/exclude, hidden, symlink, size, supported types);
  • sensitive — sensitive-directory warnings (RFC-003 §7);
  • scanner — file discovery and change detection (RFC-004).

The GUI never calls into this crate; it goes through orbok-core service interfaces (RFC-027 boundary rule).

Re-exports§

pub use path_guard::GuardedSource;
pub use path_guard::PathGuard;
pub use path_guard::ValidatedPath;
pub use policy::CompiledPolicy;
pub use policy::FileTypeClass;
pub use scanner::ScanOutcomeKind;
pub use scanner::ScanRequest;
pub use scanner::ScanSummary;
pub use scanner::Scanner;
pub use sensitive::sensitive_warning;

Modules§

hashing
Streaming content hashing (RFC-004 §9.2: sha256, streamed, never loading whole files into memory — NFR-023).
path_guard
Backend file-access boundary (RFC-003 §8).
policy
Compiled source policy (RFC-003 §6, RFC-004 scanner inputs).
scanner
File scanner and change detection (RFC-004).
sensitive
Sensitive-directory warnings (RFC-003 §7, external design §18.2).