Struct littlefs::LittleFs

pub struct LittleFs<T: Storage> { /* private fields */ }

An instance of the Little filesystem. This struct defines the method of interacting with the filesystem and contains all of the data required for the C software.

Implementations

impl<T: Storage> LittleFs<T>

Interface to the LittleFS.

pub fn new(storage: T) -> Self

Create a new instance of the LittleFS.

pub fn format(&mut self) -> Result<(), FsError>

Format the filesystem.

pub fn mount(&mut self) -> Result<(), FsError>

Mount the filesystem.

pub fn unmount(self) -> Result<(), FsError>

Unmount the filesystem.

pub fn remove(&mut self, path: &str) -> Result<(), FsError>

Remove a file or directory.

pub fn rename(&mut self, old_path: &str, new_path: &str) -> Result<(), FsError>

Rename or move a file or directory.

pub fn stat(&mut self, path: &str, info: &mut Info) -> Result<(), FsError>

Populate info for file or directory at specified path.

pub fn file_open(
    &mut self,
    file: &mut File,
    path: &str,
    flags: FileOpenFlags
) -> Result<(), FsError>

Open a file at the given path.

pub fn file_close(&mut self, file: File) -> Result<(), FsError>

Close out the given file.

pub fn file_sync(&mut self, file: File) -> Result<(), FsError>

Synchronize file contents to storage.

pub fn file_read(
    &mut self,
    file: &mut File,
    buf: &mut [u8]
) -> Result<usize, FsError>

Read data from file.

pub fn file_write(
    &mut self,
    file: &mut File,
    buf: &[u8]
) -> Result<usize, FsError>

Write data to file.

pub fn file_seek(
    &mut self,
    file: &mut File,
    off: isize,
    whence: Whence
) -> Result<usize, FsError>

Change position of subsequent read / write in file.

pub fn file_truncate(
    &mut self,
    file: &mut File,
    size: usize
) -> Result<(), FsError>

pub fn file_tell(&mut self, file: &mut File) -> Result<usize, FsError>

Tell current position of handle within the file.

pub fn file_rewind(&mut self, file: &mut File) -> Result<(), FsError>

Rewind file handle to the start of the file.

pub fn file_size(&mut self, file: &mut File) -> Result<usize, FsError>

Return total number of bytes in file.

pub fn mkdir(&mut self, path: &str) -> Result<(), FsError>

Create a new directory.

pub fn dir_open(&mut self, dir: &mut Dir, path: &str) -> Result<(), FsError>

Open a directory.

pub fn dir_close(&mut self, dir: Dir) -> Result<(), FsError>

Close a directory.

pub fn dir_read(&mut self, dir: &mut Dir) -> Result<Option<Info>, FsError>

Read contents of a directory.

pub fn dir_seek(&mut self, dir: &mut Dir, offset: isize) -> Result<(), FsError>

Change the position within the directory.

pub fn dir_tell(&mut self, dir: &mut Dir) -> Result<usize, FsError>

Report position within the directory.

pub fn dir_rewind(&mut self, dir: &mut Dir) -> Result<(), FsError>

Rewrite directory handle back to start of directory.