Struct Storage

pub struct Storage<F> { /* private fields */ }

Available on crate feature storage only.

Object holding an instance of a key-value pair storage.

You should probably look into using the global instance accessible via ariel_os_storage::storage::{get,insert,remove}.

Implementations

impl<F> Storage<F>

where F: NorFlash,

pub const fn new(flash: F, storage_range: Range<u32>) -> Storage<F>

Creates a new Storage instance.

pub async fn get_raw<V>( &mut self, key: &str, ) -> Result<Option<V>, Error<<F as ErrorType>::Error>>

where V: for<'d> Value<'d>,

Gets a [Value] from this Storage instance.

Panics

Currently panics if key.len() > MAX_KEY_LEN.

pub async fn insert_raw<'d, V>( &mut self, key: &str, value: V, ) -> Result<(), Error<<F as ErrorType>::Error>>

where V: Value<'d>,

Inserts a [Value] into this Storage instance.

Panics

Currently panics if key.len() > MAX_KEY_LEN.

pub async fn insert<'d, V>( &mut self, key: &str, value: V, ) -> Result<(), Error<<F as ErrorType>::Error>>

where V: Serialize + Deserialize<'d> + Into<PostcardValue<V>>,

Stores a key-value pair into flash memory.

It will overwrite the last value that has the same key.

pub async fn get<V>( &mut self, key: &str, ) -> Result<Option<V>, Error<<F as ErrorType>::Error>>

where V: Serialize + for<'d> Deserialize<'d> + Into<PostcardValue<V>>,

Gets the last stored value from the flash that is associated with the given key.

If no value with the key is found, None is returned.

Panics

Currently panics if key.len() > MAX_KEY_LEN.

pub async fn erase_all(&mut self) -> Result<(), Error<<F as ErrorType>::Error>>

Resets the flash in the entire flash range of this Storage instance.

impl<F> Storage<F>

where F: MultiwriteNorFlash,

pub async fn remove( &mut self, key: &str, ) -> Result<(), Error<<F as ErrorType>::Error>>

Deletes an item from flash.

Additional calls to Storage::get() with the same key will return None until a new one is stored again.

This is really slow!

All items in flash have to be read and deserialized to find the items with the key. This is unlikely to be cached well.

Panics

Currently panics if key.len() > MAX_KEY_LEN.