Struct embedded_sdmmc::Controller

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

A Controller wraps a block device and gives access to the volumes within it.

Implementations

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

pub fn new(block_device: D, timesource: T) -> Controller<D, T, 4, 4>

Create a new Disk Controller using a generic BlockDevice. From this controller we can open volumes (partitions) and with those we can open files.

This creates a Controller with default values MAX_DIRS = 4, MAX_FILES = 4. Call Controller::new_with_limits(block_device, timesource) if you need different limits.

impl<D, T, const MAX_DIRS: usize, const MAX_FILES: usize> Controller<D, T, MAX_DIRS, MAX_FILES>where
    D: BlockDevice,
    T: TimeSource,
    <D as BlockDevice>::Error: Debug,

pub fn new_with_limits(
    block_device: D,
    timesource: T
) -> Controller<D, T, MAX_DIRS, MAX_FILES>

Create a new Disk Controller using a generic BlockDevice. From this controller we can open volumes (partitions) and with those we can open files.

pub fn device(&mut self) -> &mut D

Temporarily get access to the underlying block device.

pub fn get_volume(
    &mut self,
    volume_idx: VolumeIdx
) -> Result<Volume, 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_root_dir(
    &mut self,
    volume: &Volume
) -> Result<Directory, Error<D::Error>>

Open a directory.

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

TODO: Work out how to prevent damage occuring to the file system while this directory handle is open. In particular, stop this directory being unlinked.

pub fn open_dir(
    &mut self,
    volume: &Volume,
    parent_dir: &Directory,
    name: &str
) -> Result<Directory, Error<D::Error>>

Open a directory.

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

TODO: Work out how to prevent damage occuring to the file system while this directory handle is open. In particular, stop this directory being unlinked.

pub fn close_dir(&mut self, volume: &Volume, dir: Directory)

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 find_directory_entry(
    &mut self,
    volume: &Volume,
    dir: &Directory,
    name: &str
) -> Result<DirEntry, Error<D::Error>>

Look in a directory for a named file.

pub fn iterate_dir<F>(
    &mut self,
    volume: &Volume,
    dir: &Directory,
    func: F
) -> Result<(), Error<D::Error>>where
    F: FnMut(&DirEntry),

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

pub fn open_dir_entry(
    &mut self,
    volume: &mut Volume,
    dir_entry: DirEntry,
    mode: Mode
) -> Result<File, Error<D::Error>>

Open a file from DirEntry. This is obtained by calling iterate_dir. A file can only be opened once.

pub fn open_file_in_dir(
    &mut self,
    volume: &mut Volume,
    dir: &Directory,
    name: &str,
    mode: Mode
) -> Result<File, Error<D::Error>>

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

pub fn delete_file_in_dir(
    &mut self,
    volume: &Volume,
    dir: &Directory,
    name: &str
) -> Result<(), Error<D::Error>>

Delete a closed file with the given full path, if exists.

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

Read from an open file.

pub fn write(
    &mut self,
    volume: &mut Volume,
    file: &mut File,
    buffer: &[u8]
) -> Result<usize, Error<D::Error>>

Write to a open file.

pub fn close_file(
    &mut self,
    volume: &Volume,
    file: File
) -> Result<(), Error<D::Error>>

Close a file with the given full path.

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