mod disk;
mod memory;
mod overlay;
use std::path::{Path, PathBuf};
pub use disk::DiskVfs;
pub use memory::MemoryVfs;
pub use overlay::Overlay;
#[derive(Debug, thiserror::Error)]
pub enum VfsError {
#[error("file not found: {0}")]
NotFound(PathBuf),
#[error("{path}: not valid UTF-8")]
InvalidUtf8 { path: PathBuf },
#[error("{path}: {source}")]
Io {
path: PathBuf,
#[source]
source: std::io::Error,
},
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Stamp {
modified: u128,
len: u64,
}
impl Stamp {
pub fn new(modified: u128, len: u64) -> Self {
Self { modified, len }
}
}
pub trait Vfs: Send + Sync {
fn read(&self, path: &Path) -> Result<String, VfsError>;
fn stamp(&self, path: &Path) -> Result<Stamp, VfsError>;
fn write(&self, path: &Path, contents: &str) -> Result<(), VfsError>;
fn exists(&self, path: &Path) -> bool;
fn rename(&self, from: &Path, to: &Path) -> Result<(), VfsError>;
fn walk(&self, root: &Path) -> Result<Vec<PathBuf>, VfsError>;
}