Expand description
§Qubit FS
Provider-neutral synchronous and asynchronous filesystem abstraction.
This crate defines filesystem properties and operation traits, explicit
file handles over qubit_io streams, distinct URI and provider-local path
models, typed capabilities and outcomes, recoverable writer and temporary
resource lifecycles. Runtime provider discovery and SPI integration live in
the companion qubit-fs-registry crate. This crate contains no concrete
storage backend and binds to no asynchronous runtime.
§Addressing a resource
use qubit_fs::Path;
let path = Path::parse("/reports/2026/summary.csv")?;
assert!(path.is_absolute());Application code uses the concrete facades and their handles. Provider
contracts are available only under spi. Legacy resource wrappers and
provider-local path values are not public API.
ⓘ
use qubit_fs::FileResource;ⓘ
use qubit_fs::FsPath;ⓘ
use qubit_fs::FileSystemSpi;ⓘ
use qubit_fs::temp::TempFileOptions;ⓘ
use qubit_fs::temp::TempDirOptions;ⓘ
use qubit_fs::TempDirectoryOptions;ⓘ
use qubit_fs::rustdoc_provider;Re-exports§
pub use error::FsEffectState;pub use error::FsError;pub use error::FsResult;pub use path::Path;
Modules§
- copy
- Typed copy failure state shared across the facade and provider boundary.
- directory
- Directory options, streams, outcomes, and facade operation objects.
- error
- Error types used by filesystem abstractions.
- metadata
- Metadata types exposed by filesystem implementations.
- path
- Path and URI models.
- read
- File read options, handles, and facade operation objects.
- rename
- Typed rename failure state shared across the facade and provider boundary.
- spi
- Provider service-provider interface; application code uses
crate::FileSystem. - temp
- Temporary filesystem resource handles and persistence outcomes.
- write
- File write options, handles, outcomes, and facade operation objects.
Structs§
- Async
File System - Application-facing asynchronous filesystem facade.
- File
System - Application-facing synchronous filesystem facade.