Struct FileSystem 

pub struct FileSystem<S>
where
    S: Read + Seek,
{ /* private fields */ }

An API to process a FAT filesystem

Implementations

impl<S> FileSystem<S>

where S: Read + Seek,

Getter functions

pub fn fat_type(&self) -> FATType

What is the FATType of the filesystem

impl<S> FileSystem<S>

where S: Read + Seek,

Setter functions

pub fn show_hidden(&self, show: bool)

Whether or not to list hidden files

Off by default

pub fn show_system(&self, show: bool)

Whether or not to list system files

Off by default

impl<S> FileSystem<S>

where S: Read + Seek,

Constructors for a FileSystem

pub fn new(storage: S, options: FSOptions) -> FSResult<Self, S::Error>

Create a FileSystem from a storage object

Fails if the storage is way too small to support a FAT filesystem. For most use cases, that shouldn’t be an issue, you can just call .unwrap()

impl<S> FileSystem<S>

where S: Read + Seek,

Public Read-related functions

pub fn read_dir<P: AsRef<Path>>( &self, path: P, ) -> FSResult<ReadDir<'_, S>, S::Error>

Read all the entries of a directory (Path) into ReadDir

Fails if path doesn’t represent a directory, or if that directory doesn’t exist

pub fn get_ro_file<P: AsRef<Path>>( &self, path: P, ) -> FSResult<ROFile<'_, S>, S::Error>

Get a corresponding ROFile object from a Path

Fails if path doesn’t represent a file, or if that file doesn’t exist

impl<S> FileSystem<S>

where S: Read + Write + Seek,

Write-related functions

pub fn create_file<P: AsRef<Path>>( &self, path: P, ) -> FSResult<RWFile<'_, S>, S::Error>

Create a new RWFile and return its handle

pub fn create_dir<P: AsRef<Path>>(&self, path: P) -> FSResult<(), S::Error>

Create a new directory

pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>( &self, from: P, to: Q, ) -> FSResult<(), S::Error>

Rename a file or directory to a new name

pub fn remove_file<P: AsRef<Path>>(&self, path: P) -> FSResult<(), S::Error>

Remove a RWFile from the filesystem

This is an alias to self.get_rw_file(path)?.remove()?

pub fn remove_file_unchecked<P: AsRef<Path>>( &self, path: P, ) -> FSResult<(), S::Error>

Remove a file from the filesystem, even if it is read-only

USE WITH EXTREME CAUTION!

pub fn remove_empty_dir<P: AsRef<Path>>( &self, path: P, ) -> FSResult<(), S::Error>

Remove an empty directory from the filesystem

Errors if the path provided points to the root directory

pub fn remove_dir_all<P: AsRef<Path>>(&self, path: P) -> FSResult<(), S::Error>

Removes a directory at this path, after removing all its contents.

Use with caution!

This will fail if there is at least 1 (one) read-only file in this directory or in any subdirectory. To avoid this behavior, use remove_dir_all_unchecked()

pub fn remove_dir_all_unchecked<P: AsRef<Path>>( &self, path: P, ) -> FSResult<(), S::Error>

Like remove_dir_all(), but also removes read-only files.

USE WITH EXTREME CAUTION!

pub fn check_for_readonly_files<P: AsRef<Path>>( &self, path: P, ) -> FSResult<bool, S::Error>

Check path recursively to see if there are any read-only files in it

If successful, the bool returned indicates whether or not at least 1 (one) read-only file has been found

pub fn get_rw_file<P: AsRef<Path>>( &self, path: P, ) -> FSResult<RWFile<'_, S>, S::Error>

Get a corresponding RWFile object from a Path

Fails if path doesn’t represent a file, or if that file doesn’t exist

pub fn unmount(&self) -> FSResult<(), S::Error>

Sync any pending changes back to the storage medium and drop

Use this to catch any IO errors that might be rejected silently while Dropping

Trait Implementations

impl<S> Debug for FileSystem<S>

where S: Read + Seek + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Drop for FileSystem<S>

where S: Read + Seek,

fn drop(&mut self)

Executes the destructor for this type.