Struct Filesystem 

pub struct Filesystem<S: Storage> { /* private fields */ }

A mounted LittleFS filesystem.

All methods take &self via interior mutability, so multiple File and ReadDir handles can coexist. The internal state is heap-allocated and pinned so that core pointers remain stable across moves.

Use Filesystem::format to initialize storage, then Filesystem::mount to obtain a Filesystem. Call Filesystem::unmount to cleanly unmount and recover the storage, or let Drop handle it automatically.

Filesystem is !Send and !Sync (due to interior RefCell). This is appropriate for single-threaded embedded use. If you need cross-thread access, wrap it in a Mutex.

Implementations

impl<S: Storage> Filesystem<S>

pub fn format(storage: &mut S, config: &Config) -> Result<(), Error>

Format storage with a fresh LittleFS filesystem.

This erases any existing data. The storage can be mounted afterwards with Filesystem::mount.

pub fn mount(storage: S, config: Config) -> Result<Self, (Error, S)>

Mount an existing filesystem. Takes ownership of the storage.

On failure the storage is returned alongside the error so the caller can retry (e.g. format + mount).

pub fn unmount(self) -> Result<S, Error>

Unmount and return the underlying storage.

Prefer this over dropping when you need to check for errors or reuse the storage.

pub fn open(&self, path: &str, flags: OpenFlags) -> Result<File<'_, S>, Error>

Open a file with the given OpenFlags.

Common combinations: READ, WRITE | CREATE | TRUNC, WRITE | CREATE | APPEND.

pub fn read_to_vec(&self, path: &str) -> Result<Vec<u8>, Error>

Read an entire file into a Vec<u8>.

pub fn write_file(&self, path: &str, data: &[u8]) -> Result<(), Error>

Write data to a file, creating or truncating it.

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

Create a directory. Fails if it already exists.

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

Remove a file or empty directory.

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

Rename or move a file or directory.

pub fn stat(&self, path: &str) -> Result<Metadata, Error>

Get metadata for a file or directory.

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

Returns true if path exists.

pub fn read_dir(&self, path: &str) -> Result<ReadDir<'_, S>, Error>

Open a directory for iteration. The returned ReadDir is an Iterator that skips . and .. entries.

pub fn list_dir(&self, path: &str) -> Result<Vec<DirEntry>, Error>

Collect all entries in a directory into a Vec.

pub fn fs_size(&self) -> Result<u32, Error>

Return the number of allocated blocks.

pub fn gc(&self) -> Result<(), Error>

Run garbage collection to reclaim unused blocks.

Trait Implementations

impl<S: Storage> Drop for Filesystem<S>

fn drop(&mut self)

Executes the destructor for this type.