haz-vfs 0.2.0

Filesystem abstraction used by the haz task runner.
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

//! Filesystem port used by every filesystem-touching crate in
//! `haz`.
//!
//! `haz-vfs` is the hexagonal port: it defines the [`Filesystem`]
//! trait, its supporting value types, and the [`FsError`] variant
//! set every implementation produces. The production implementation
//! [`StdFilesystem`] ships with the crate; an in-memory
//! implementation for tests lives in the `haz-vfs-testing` crate.
//!
//! - [`StdFilesystem`] for production code. Delegates straight to
//!   [`std::fs`] and inherits the host platform's symlink, depth-cap,
//!   and canonicalisation semantics.
//!
//! Consumers (`haz-discovery`, `haz-cache`, `haz-exec`) borrow a
//! `Filesystem` implementation generically rather than depending on
//! a concrete impl.

#![deny(missing_docs)]

pub mod std_impl;
pub mod traits;

pub use std_impl::{StdCanonicalPath, StdFilesystem};
pub use traits::{DirEntry, EntryKind, Filesystem, FsError, FsMetadata, WritableFilesystem};