Struct Storage 

pub struct Storage<M>
where
    M: StorageMedium,
    [(); M::BLOCK_COUNT]:,
{ /* private fields */ }

A mounted storage partition.

Implementations

impl<M> Storage<M>

where M: StorageMedium, [(); M::BLOCK_COUNT]:,

pub async fn mount(partition: M) -> Result<Self, StorageError>

Mounts the filesystem.

Returns an error if the filesystem is not formatted.

pub async fn format(partition: &mut M) -> Result<(), StorageError>

Unconditionally formats the filesystem.

pub async fn format_and_mount(partition: M) -> Result<Self, StorageError>

Unconditionally formats then mounts the filesystem.

pub fn capacity(&self) -> usize

Returns the total capacity of the filesystem in bytes.

pub fn free_bytes(&self) -> usize

Returns the number of free bytes in the filesystem.

Note: this function does not count deleted files as free space, so the result will not match the value capacity() - used_bytes().

pub async fn used_bytes(&mut self) -> Result<usize, StorageError>

Returns the number of bytes used in the filesystem.

This function takes filesystem overhead into account, but does not count deleted files.

pub async fn delete(&mut self, path: &str) -> Result<(), StorageError>

Deletes the file at path.

pub async fn store( &mut self, path: &str, data: &[u8], if_exists: OnCollision, ) -> Result<(), StorageError>

Creates a new file at path with the given data.

If a file already exists at path, the behaviour is determined by if_exists.

• OnCollision::Overwrite will overwrite the existing file.
• OnCollision::Fail will return an error.

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

Convenience method for checking if a file exists. Ignores all errors.

pub async fn read(&mut self, path: &str) -> Result<Reader<M>, StorageError>

Opens the file at path for reading.

Returns a reader object on success and an error on failure.

Modifying the filesystem while a reader is open results in undefined behaviour.

pub async fn file_size(&mut self, path: &str) -> Result<usize, StorageError>

Returns the content size of the file at path.

impl<P> Storage<Counters<P>>

where P: StorageMedium, [(); P::BLOCK_COUNT]:, [(); Counters<P>::BLOCK_COUNT]:,

pub fn erase_count(&self) -> usize

pub fn read_count(&self) -> usize

pub fn write_count(&self) -> usize