Struct Dir 

pub struct Dir<'a, IO: ReadWriteSeek, TP, OCC> { /* private fields */ }

A FAT filesystem directory.

This struct is created by the open_dir or create_dir methods on Dir. The root directory is returned by the root_dir method on FileSystem.

Implementations

impl<'a, IO: ReadWriteSeek, TP, OCC> Dir<'a, IO, TP, OCC>

pub fn iter(&self) -> DirIter<'a, IO, TP, OCC>

Creates directory entries iterator.

impl<'a, IO: ReadWriteSeek, TP: TimeProvider, OCC: OemCpConverter> Dir<'a, IO, TP, OCC>

pub fn as_file(&self) -> Option<&File<'a, IO, TP, OCC>>

Returns the underlying file object if the directory stream is not a root directory in FAT12 & FAT16.

pub fn open_dir(&self, path: &str) -> Result<Self, Error<IO::Error>>

Opens existing subdirectory.

path is a ‘/’ separated directory path relative to self directory.

Errors

Errors that can be returned:

• Error::NotFound will be returned if path does not point to any existing directory entry.
• Error::InvalidInput will be returned if path points to a file that is not a directory.
• Error::Io will be returned if the underlying storage object returned an I/O error.

pub fn open_file( &self, path: &str, ) -> Result<File<'a, IO, TP, OCC>, Error<IO::Error>>

Opens existing file.

path is a ‘/’ separated file path relative to self directory.

Errors

Errors that can be returned:

• Error::NotFound will be returned if path points to a non-existing directory entry.
• Error::InvalidInput will be returned if path points to a file that is a directory.
• Error::Io will be returned if the underlying storage object returned an I/O error.

pub fn create_file( &self, path: &str, ) -> Result<File<'a, IO, TP, OCC>, Error<IO::Error>>

Creates new or opens existing file=.

path is a ‘/’ separated file path relative to self directory. File is never truncated when opening. It can be achieved by calling File::truncate method after opening.

Errors

Errors that can be returned:

• Error::InvalidInput will be returned if path points to an existing file that is a directory.
• Error::InvalidFileNameLength will be returned if the file name is empty or if it is too long.
• Error::UnsupportedFileNameCharacter will be returned if the file name contains an invalid character.
• Error::NotEnoughSpace will be returned if there is not enough free space to create a new file.
• Error::Io will be returned if the underlying storage object returned an I/O error.

pub fn create_dir(&self, path: &str) -> Result<Self, Error<IO::Error>>

Creates new directory or opens existing.

path is a ‘/’ separated path relative to self directory.

Errors

Errors that can be returned:

• Error::InvalidInput will be returned if path points to an existing file that is not a directory.
• Error::InvalidFileNameLength will be returned if the file name is empty or if it is too long.
• Error::UnsupportedFileNameCharacter will be returned if the file name contains an invalid character.
• Error::NotEnoughSpace will be returned if there is not enough free space to create a new directory.
• Error::Io will be returned if the underlying storage object returned an I/O error.

pub fn remove(&self, path: &str) -> Result<(), Error<IO::Error>>

Removes existing file or directory.

path is a ‘/’ separated file path relative to self directory. Make sure there is no reference to this file (no File instance) or filesystem corruption can happen.

Errors

Errors that can be returned:

• Error::NotFound will be returned if path points to a non-existing directory entry.
• Error::InvalidInput will be returned if path points to a file that is not a directory.
• Error::DirectoryIsNotEmpty will be returned if the specified directory is not empty.
• Error::Io will be returned if the underlying storage object returned an I/O error.

pub fn rename( &self, src_path: &str, dst_dir: &Dir<'_, IO, TP, OCC>, dst_path: &str, ) -> Result<(), Error<IO::Error>>

Renames or moves existing file or directory.

src_path is a ‘/’ separated source file path relative to self directory. dst_path is a ‘/’ separated destination file path relative to dst_dir. dst_dir can be set to self directory if rename operation without moving is needed. Make sure there is no reference to this file (no File instance) or filesystem corruption can happen.

Errors

Errors that can be returned:

• Error::NotFound will be returned if src_path points to a non-existing directory entry or if dst_path stripped from the last component does not point to an existing directory.
• Error::AlreadyExists will be returned if dst_path points to an existing directory entry.
• Error::Io will be returned if the underlying storage object returned an I/O error.

Trait Implementations

impl<IO: ReadWriteSeek, TP: TimeProvider, OCC: OemCpConverter> Clone for Dir<'_, IO, TP, OCC>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.