1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
//! The async filesystem trait definitions needed to implement new async virtual filesystems
use crate::async_vfs::{AsyncVfsPath, SeekAndRead};
use crate::error::VfsErrorKind;
use crate::{VfsError, VfsMetadata, VfsResult};
use async_std::io::Write;
use async_std::stream::Stream;
use async_trait::async_trait;
use std::fmt::Debug;
use std::time::SystemTime;
/// File system implementations must implement this trait
/// All path parameters are absolute, starting with '/', except for the root directory
/// which is simply the empty string (i.e. "")
/// The character '/' is used to delimit directories on all platforms.
/// Path components may be any UTF-8 string, except "/", "." and ".."
///
/// Please use the test_macros [test_macros::test_async_vfs!] and [test_macros::test_async_vfs_readonly!]
#[async_trait]
pub trait AsyncFileSystem: Debug + Sync + Send + 'static {
/// Iterates over all direct children of this directory path
/// NOTE: the returned String items denote the local bare filenames, i.e. they should not contain "/" anywhere
async fn read_dir(
&self,
path: &str,
) -> VfsResult<Box<dyn Unpin + Stream<Item = String> + Send>>;
/// Creates the directory at this path
///
/// Note that the parent directory must already exist.
async fn create_dir(&self, path: &str) -> VfsResult<()>;
/// Opens the file at this path for reading
async fn open_file(&self, path: &str) -> VfsResult<Box<dyn SeekAndRead + Send + Unpin>>;
/// Creates a file at this path for writing
async fn create_file(&self, path: &str) -> VfsResult<Box<dyn Write + Send + Unpin>>;
/// Opens the file at this path for appending
async fn append_file(&self, path: &str) -> VfsResult<Box<dyn Write + Send + Unpin>>;
/// Returns the file metadata for the file at this path
async fn metadata(&self, path: &str) -> VfsResult<VfsMetadata>;
/// Sets the files creation timestamp, if the implementation supports it
async fn set_creation_time(&self, _path: &str, _time: SystemTime) -> VfsResult<()> {
Err(VfsError::from(VfsErrorKind::NotSupported))
}
/// Sets the files modification timestamp, if the implementation supports it
async fn set_modification_time(&self, _path: &str, _time: SystemTime) -> VfsResult<()> {
Err(VfsError::from(VfsErrorKind::NotSupported))
}
/// Sets the files access timestamp, if the implementation supports it
async fn set_access_time(&self, _path: &str, _time: SystemTime) -> VfsResult<()> {
Err(VfsError::from(VfsErrorKind::NotSupported))
}
/// Returns true if a file or directory at path exists, false otherwise
async fn exists(&self, path: &str) -> VfsResult<bool>;
/// Removes the file at this path
async fn remove_file(&self, path: &str) -> VfsResult<()>;
/// Removes the directory at this path
async fn remove_dir(&self, path: &str) -> VfsResult<()>;
/// Copies the src path to the destination path within the same filesystem (optional)
async fn copy_file(&self, _src: &str, _dest: &str) -> VfsResult<()> {
Err(VfsErrorKind::NotSupported.into())
}
/// Moves the src path to the destination path within the same filesystem (optional)
async fn move_file(&self, _src: &str, _dest: &str) -> VfsResult<()> {
Err(VfsErrorKind::NotSupported.into())
}
/// Moves the src directory to the destination path within the same filesystem (optional)
async fn move_dir(&self, _src: &str, _dest: &str) -> VfsResult<()> {
Err(VfsErrorKind::NotSupported.into())
}
}
impl<T: AsyncFileSystem> From<T> for AsyncVfsPath {
fn from(filesystem: T) -> Self {
AsyncVfsPath::new(filesystem)
}
}