Struct VolumeManager

pub struct VolumeManager<D, T, const MAX_DIRS: usize = 4, const MAX_FILES: usize = 4, const MAX_VOLUMES: usize = 1>
where
    D: BlockDevice,
    T: TimeSource,
    <D as BlockDevice>::Error: Debug,
{ /* private fields */ }

Wraps a block device and gives access to the FAT-formatted volumes within it.

Tracks which files and directories are open, to prevent you from deleting a file or directory you currently have open.

Implementations

impl<D, T> VolumeManager<D, T, 4, 4>

where D: BlockDevice, T: TimeSource, <D as BlockDevice>::Error: Debug,

pub fn new(block_device: D, time_source: T) -> VolumeManager<D, T, 4, 4, 1>

Create a new Volume Manager using a generic BlockDevice. From this object we can open volumes (partitions) and with those we can open files.

This creates a VolumeManager with default values MAX_DIRS = 4, MAX_FILES = 4, MAX_VOLUMES = 1. Call VolumeManager::new_with_limits(block_device, time_source) if you need different limits.

impl<D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

where D: BlockDevice, T: TimeSource, <D as BlockDevice>::Error: Debug,

pub fn new_with_limits( block_device: D, time_source: T, id_offset: u32, ) -> VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

Create a new Volume Manager using a generic BlockDevice. From this object we can open volumes (partitions) and with those we can open files.

You can also give an offset for all the IDs this volume manager generates, which might help you find the IDs in your logs when debugging.

pub fn device<F>(&self, f: F) -> T

where F: FnOnce(&mut D) -> T,

Temporarily get access to the underlying block device.

pub fn open_volume( &self, volume_idx: VolumeIdx, ) -> Result<Volume<'_, D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>, Error<D::Error>>

Get a volume (or partition) based on entries in the Master Boot Record.

We do not support GUID Partition Table disks. Nor do we support any concept of drive letters - that is for a higher layer to handle.

pub fn open_raw_volume( &self, volume_idx: VolumeIdx, ) -> Result<RawVolume, Error<D::Error>>

Get a volume (or partition) based on entries in the Master Boot Record.

We do not support GUID Partition Table disks. Nor do we support any concept of drive letters - that is for a higher layer to handle.

This function gives you a RawVolume and you must close the volume by calling VolumeManager::close_volume.

pub fn open_root_dir( &self, volume: RawVolume, ) -> Result<RawDirectory, Error<D::Error>>

Open the volume’s root directory.

You can then read the directory entries with iterate_dir, or you can use open_file_in_dir.

pub fn open_dir<N>( &self, parent_dir: RawDirectory, name: N, ) -> Result<RawDirectory, Error<D::Error>>

where N: ToShortFileName,

Open a directory.

You can then read the directory entries with iterate_dir and open_file_in_dir.

Passing “.” as the name results in opening the parent_dir a second time.

pub fn close_dir(&self, directory: RawDirectory) -> Result<(), Error<D::Error>>

Close a directory. You cannot perform operations on an open directory and so must close it if you want to do something with it.

pub fn close_volume(&self, volume: RawVolume) -> Result<(), Error<D::Error>>

Close a volume

You can’t close it if there are any files or directories open on it.

pub fn find_directory_entry<N>( &self, directory: RawDirectory, name: N, ) -> Result<DirEntry, Error<D::Error>>

where N: ToShortFileName,

Look in a directory for a named file.

pub fn iterate_dir<F>( &self, directory: RawDirectory, func: F, ) -> Result<(), Error<D::Error>>

where F: FnMut(&DirEntry),

Call a callback function for each directory entry in a directory.

Long File Names will be ignored.

Do not attempt to call any methods on the VolumeManager or any of its handles from inside the callback. You will get a lock error because the object is already locked in order to do the iteration.

pub fn iterate_dir_lfn<F>( &self, directory: RawDirectory, lfn_buffer: &mut LfnBuffer<'_>, func: F, ) -> Result<(), Error<D::Error>>

where F: FnMut(&DirEntry, Option<&str>),

Call a callback function for each directory entry in a directory, and process Long File Names.

You must supply a LfnBuffer this API can use to temporarily hold the Long File Name. If you pass one that isn’t large enough, any Long File Names that don’t fit will be ignored and presented as if they only had a Short File Name.

Do not attempt to call any methods on the VolumeManager or any of its handles from inside the callback. You will get a lock error because the object is already locked in order to do the iteration.

pub fn open_file_in_dir<N>( &self, directory: RawDirectory, name: N, mode: Mode, ) -> Result<RawFile, Error<D::Error>>

where N: ToShortFileName,

Open a file with the given full path. A file can only be opened once.

pub fn delete_file_in_dir<N>( &self, directory: RawDirectory, name: N, ) -> Result<(), Error<D::Error>>

where N: ToShortFileName,

Delete a closed file with the given filename, if it exists.

pub fn get_root_volume_label( &self, raw_volume: RawVolume, ) -> Result<Option<VolumeName>, Error<D::Error>>

Get the volume label

Will look in the BPB for a volume label, and if nothing is found, will search the root directory for a volume label.

pub fn read( &self, file: RawFile, buffer: &mut [u8], ) -> Result<usize, Error<D::Error>>

Read from an open file.

pub fn write(&self, file: RawFile, buffer: &[u8]) -> Result<(), Error<D::Error>>

Write to a open file.

pub fn close_file(&self, file: RawFile) -> Result<(), Error<D::Error>>

Close a file with the given raw file handle.

pub fn flush_file(&self, file: RawFile) -> Result<(), Error<D::Error>>

Flush (update the entry) for a file with the given raw file handle.

pub fn has_open_handles(&self) -> bool

Check if any files or folders are open.

pub fn free(self) -> (D, T)

Consume self and return BlockDevice and TimeSource

pub fn file_eof(&self, file: RawFile) -> Result<bool, Error<D::Error>>

Check if a file is at End Of File.

pub fn file_seek_from_start( &self, file: RawFile, offset: u32, ) -> Result<(), Error<D::Error>>

Seek a file with an offset from the start of the file.

pub fn file_seek_from_current( &self, file: RawFile, offset: i32, ) -> Result<(), Error<D::Error>>

Seek a file with an offset from the current position.

pub fn file_seek_from_end( &self, file: RawFile, offset: u32, ) -> Result<(), Error<D::Error>>

Seek a file with an offset back from the end of the file.

pub fn file_length(&self, file: RawFile) -> Result<u32, Error<D::Error>>

Get the length of a file

pub fn file_offset(&self, file: RawFile) -> Result<u32, Error<D::Error>>

Get the current offset of a file

pub fn make_dir_in_dir<N>( &self, directory: RawDirectory, name: N, ) -> Result<(), Error<D::Error>>

where N: ToShortFileName,

Create a directory in a given directory.

Trait Implementations

impl<D, T, const MAX_DIRS: usize, const MAX_FILES: usize, const MAX_VOLUMES: usize> Debug for VolumeManager<D, T, MAX_DIRS, MAX_FILES, MAX_VOLUMES>

where D: BlockDevice + Debug, T: TimeSource + Debug, <D as BlockDevice>::Error: Debug,

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

Formats the value using the given formatter.