Trait FileSystem

pub trait FileSystem: Send + Sync {
    type File: File;

    // Required methods
    fn open_file(
        &self,
        path: impl AsRef<Utf8Path>,
        flags: OpenFlags,
    ) -> Result<Self::File>;
    fn metadata(&self, path: impl AsRef<Utf8Path>) -> Result<Metadata>;
    fn rename(
        &self,
        from: impl AsRef<Utf8Path>,
        to: impl AsRef<Utf8Path>,
    ) -> Result<()>;
    fn exists(&self, path: impl AsRef<Utf8Path>) -> Result<bool>;
    fn create_dir(&self, path: impl AsRef<Utf8Path>) -> Result<()>;
    fn remove_dir(&self, path: impl AsRef<Utf8Path>) -> Result<()>;
    fn remove_file(&self, path: impl AsRef<Utf8Path>) -> Result<()>;
    fn read_dir(&self, path: impl AsRef<Utf8Path>) -> Result<Vec<DirEntry>>;

    // Provided methods
    fn create_file(&self, path: impl AsRef<Utf8Path>) -> Result<Self::File> { ... }
    fn remove(&self, path: impl AsRef<Utf8Path>) -> Result<()> { ... }
    fn read(&self, path: impl AsRef<Utf8Path>) -> Result<Vec<u8>> { ... }
    fn read_to_string(&self, path: impl AsRef<Utf8Path>) -> Result<String> { ... }
    fn write(
        &self,
        path: impl AsRef<Utf8Path>,
        data: impl AsRef<[u8]>,
    ) -> Result<()> { ... }
}

Required Associated Types

type File: File

Required Methods

fn open_file( &self, path: impl AsRef<Utf8Path>, flags: OpenFlags, ) -> Result<Self::File>

fn metadata(&self, path: impl AsRef<Utf8Path>) -> Result<Metadata>

fn rename( &self, from: impl AsRef<Utf8Path>, to: impl AsRef<Utf8Path>, ) -> Result<()>

fn exists(&self, path: impl AsRef<Utf8Path>) -> Result<bool>

fn create_dir(&self, path: impl AsRef<Utf8Path>) -> Result<()>

fn remove_dir(&self, path: impl AsRef<Utf8Path>) -> Result<()>

fn remove_file(&self, path: impl AsRef<Utf8Path>) -> Result<()>

fn read_dir(&self, path: impl AsRef<Utf8Path>) -> Result<Vec<DirEntry>>

Provided Methods

fn create_file(&self, path: impl AsRef<Utf8Path>) -> Result<Self::File>

fn remove(&self, path: impl AsRef<Utf8Path>) -> Result<()>

fn read(&self, path: impl AsRef<Utf8Path>) -> Result<Vec<u8>>

Corresponds to std::fs::read(). Will open a file at the path and read the entire file into a buffer.

fn read_to_string(&self, path: impl AsRef<Utf8Path>) -> Result<String>

fn write( &self, path: impl AsRef<Utf8Path>, data: impl AsRef<[u8]>, ) -> Result<()>

Corresponds to std::fs::write(). Will open a file at the path, create it if it does not exist (and truncate it) and then write the provided bytes.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl FileSystem for luminol_filesystem::project::FileSystem

type File = File

impl FileSystem for luminol_filesystem::list::FileSystem

type File = Box<dyn File>

impl FileSystem for luminol_filesystem::native::FileSystem

type File = File

impl FileSystem for dyn ErasedFilesystem

type File = Box<dyn File>

impl<F> FileSystem for luminol_filesystem::path_cache::FileSystem<F>

where F: FileSystemTrait,

type File = <F as FileSystem>::File

impl<T> FileSystem for luminol_filesystem::archiver::FileSystem<T>

where T: File,

type File = File<T>