Struct Filesystem

pub struct Filesystem<'a, Storage: Storage> { /* private fields */ }

Implementations

impl<Storage: Storage> Filesystem<'_, Storage>

pub fn allocate() -> Allocation<Storage>

pub fn format(storage: &mut Storage) -> Result<()>

pub fn is_mountable(storage: &mut Storage) -> bool

pub unsafe fn borrow_storage_mut(&mut self) -> &mut Storage

pub fn mount_and_then<R>( storage: &mut Storage, f: impl FnOnce(&Filesystem<'_, Storage>) -> Result<R>, ) -> Result<R>

This API avoids the need for using Allocation.

pub fn total_blocks(&self) -> usize

Total number of blocks in the filesystem

pub fn total_space(&self) -> usize

Total number of bytes in the filesystem

pub fn available_blocks(&self) -> Result<usize>

Available number of unused blocks in the filesystem

Upstream littlefs documentation notes (on its “current size” function): “Result is best effort. If files share COW structures, the returned size may be larger than the filesystem actually is.”

So it would seem that there are at least the number of blocks returned by this method available, at any given time.

pub fn available_space(&self) -> Result<usize>

Available number of unused bytes in the filesystem

This is a lower bound, more may be available. First, more blocks may be available as explained in available_blocks. Second, files may be inlined.

pub fn remove(&self, path: &Path) -> Result<()>

Remove a file or directory.

pub fn remove_dir(&self, path: &Path) -> Result<()>

Remove a file or directory.

pub fn remove_dir_all(&self, path: &Path) -> Result<()>

TODO: This method fails if some println! calls are removed. Whyy?

pub fn remove_dir_all_where<P>( &self, path: &Path, predicate: &P, ) -> Result<usize>

where P: Fn(&DirEntry) -> bool,

pub fn rename(&self, from: &Path, to: &Path) -> Result<()>

Rename or move a file or directory.

pub fn exists(&self, path: &Path) -> bool

Check whether a file or directory exists at a path.

This is equivalent to calling Filesystem::metadata and checking for an Ok return value.

pub fn metadata(&self, path: &Path) -> Result<Metadata>

Given a path, query the filesystem to get information about a file or directory.

To read user attributes, use Filesystem::attribute

pub fn create_file_and_then<R>( &self, path: &Path, f: impl FnOnce(&File<'_, '_, Storage>) -> Result<R>, ) -> Result<R>

pub fn open_file_and_then<R>( &self, path: &Path, f: impl FnOnce(&File<'_, '_, Storage>) -> Result<R>, ) -> Result<R>

pub fn with_options() -> OpenOptions

pub fn open_file_with_options_and_then<R>( &self, o: impl FnOnce(&mut OpenOptions) -> &OpenOptions, path: &Path, f: impl FnOnce(&File<'_, '_, Storage>) -> Result<R>, ) -> Result<R>

pub fn attribute<'a>( &self, path: &Path, id: u8, buffer: &'a mut [u8], ) -> Result<Option<Attribute<'a>>>

Read attribute.

pub fn remove_attribute(&self, path: &Path, id: u8) -> Result<()>

Remove attribute.

pub fn set_attribute(&self, path: &Path, id: u8, data: &[u8]) -> Result<()>

Set attribute.

impl<'a, Storage: Storage> Filesystem<'a, Storage>

pub fn read_dir_and_then<R>( &self, path: &Path, f: impl FnOnce(&mut ReadDir<'_, '_, Storage>) -> Result<R>, ) -> Result<R>

pub unsafe fn read_dir<'b>( &'b self, alloc: &'b mut ReadDirAllocation, path: &'b Path, ) -> Result<ReadDir<'a, 'b, Storage>>

Returns a pseudo-iterator over the entries within a directory.

This is unsafe since it can induce UB just like File::open.

impl<'a, Storage: Storage> Filesystem<'a, Storage>

pub fn mount( alloc: &'a mut Allocation<Storage>, storage: &'a mut Storage, ) -> Result<Self>

pub fn mount_or_else<F>( alloc: &'a mut Allocation<Storage>, storage: &'a mut Storage, f: F, ) -> Result<Self>

where F: FnOnce(Error, &mut Storage) -> Result<()>,

Mount the filesystem or, if that fails, call f with the mount error and the storage and then try again.

pub fn into_inner(self) -> (&'a mut Allocation<Storage>, &'a mut Storage)

Deconstruct Filesystem, intention is to allow access to the underlying Flash peripheral in driver::Storage etc.

See also borrow_storage_mut.

pub fn create_dir(&self, path: &Path) -> Result<()>

Creates a new, empty directory at the provided path.

pub fn create_dir_all(&self, path: &Path) -> Result<()>

Recursively create a directory and all of its parent components if they are missing.

pub fn read<const N: usize>(&self, path: &Path) -> Result<Vec<u8, N>>

Read the entire contents of a file into a bytes vector.

pub fn read_chunk<const N: usize>( &self, path: &Path, pos: OpenSeekFrom, ) -> Result<(Vec<u8, N>, usize)>

Read a chunk of a file into a bytes vector Returns the data and the size of the file

pub fn write(&self, path: &Path, contents: &[u8]) -> Result<()>

Write a slice as the entire contents of a file.

This function will create a file if it does not exist, and will entirely replace its contents if it does.

pub fn write_chunk( &self, path: &Path, contents: &[u8], pos: OpenSeekFrom, ) -> Result<()>

Write a slice as a chunk of a file.

This function will not create a file if it does not exist, it will fail if the file is not already large enough with regard to the pos parameter

Trait Implementations

impl<S: Storage> DynFilesystem for Filesystem<'_, S>

fn total_blocks(&self) -> usize

fn total_space(&self) -> usize

fn available_blocks(&self) -> Result<usize>

fn available_space(&self) -> Result<usize>

fn remove(&self, path: &Path) -> Result<()>

fn remove_dir(&self, path: &Path) -> Result<()>

fn remove_dir_all(&self, path: &Path) -> Result<()>

fn remove_dir_all_where( &self, path: &Path, predicate: Predicate<'_>, ) -> Result<usize>

fn rename(&self, from: &Path, to: &Path) -> Result<()>

fn exists(&self, path: &Path) -> bool

fn metadata(&self, path: &Path) -> Result<Metadata>

fn create_file_and_then_unit( &self, path: &Path, f: FileCallback<'_>, ) -> Result<()>

fn open_file_and_then_unit( &self, path: &Path, f: FileCallback<'_>, ) -> Result<()>

fn open_file_with_flags_and_then_unit( &self, flags: FileOpenFlags, path: &Path, f: FileCallback<'_>, ) -> Result<()>

fn attribute<'a>( &self, path: &Path, id: u8, buffer: &'a mut [u8], ) -> Result<Option<Attribute<'a>>>

fn remove_attribute(&self, path: &Path, id: u8) -> Result<()>

fn set_attribute(&self, path: &Path, id: u8, data: &[u8]) -> Result<()>

fn read_dir_and_then_unit( &self, path: &Path, f: DirEntriesCallback<'_>, ) -> Result<()>

fn create_dir(&self, path: &Path) -> Result<()>

fn create_dir_all(&self, path: &Path) -> Result<()>

fn write(&self, path: &Path, contents: &[u8]) -> Result<()>

fn write_chunk( &self, path: &Path, contents: &[u8], pos: OpenSeekFrom, ) -> Result<()>