Struct capsules_extra::tickv::TicKVSystem

pub struct TicKVSystem<'a, F: Flash + 'static, H: Hasher<'a, 8>, const PAGE_SIZE: usize> { /* private fields */ }

TicKVSystem implements KVSystem using the TicKV library.

Implementations

impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> TicKVSystem<'a, F, H, PAGE_SIZE>

pub fn new( flash: &'a F, hasher: &'a H, tickfs_read_buf: &'static mut [u8; PAGE_SIZE], flash_read_buffer: &'static mut F::Page, region_offset: usize, flash_size: usize, ) -> TicKVSystem<'a, F, H, PAGE_SIZE>

pub fn initialise(&self)

Trait Implementations

impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> Client<8> for TicKVSystem<'a, F, H, PAGE_SIZE>

fn add_mut_data_done( &self, _result: Result<(), ErrorCode>, data: SubSliceMut<'static, u8>, )

This callback is called when the data has been added to the hash engine. On error or success data will contain a reference to the original data supplied to add_mut_data(). The possible ErrorCodes are:

fn add_data_done( &self, _result: Result<(), ErrorCode>, _data: SubSlice<'static, u8>, )

This callback is called when the data has been added to the hash engine. On error or success data will contain a reference to the original data supplied to add_data(). The possible ErrorCodes are:

fn hash_done( &self, _result: Result<(), ErrorCode>, digest: &'static mut [u8; 8], )

This callback is called when a hash is computed. On error or success hash will contain a reference to the original data supplied to run(). The possible ErrorCodes are:

impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> Client<F> for TicKVSystem<'a, F, H, PAGE_SIZE>

fn read_complete( &self, pagebuffer: &'static mut F::Page, _result: Result<(), Error>, )

Flash read complete.

fn write_complete( &self, pagebuffer: &'static mut F::Page, _result: Result<(), Error>, )

Flash write complete.

fn erase_complete(&self, _result: Result<(), Error>)

Flash erase complete.

impl<'a, F: Flash, H: Hasher<'a, 8>, const PAGE_SIZE: usize> KVSystem<'a> for TicKVSystem<'a, F, H, PAGE_SIZE>

type K = [u8; 8]

The type of the hashed key. For example [u8; 8].

fn set_client(&self, client: &'a dyn KVSystemClient<Self::K>)

Set the client.

fn generate_key( &self, unhashed_key: SubSliceMut<'static, u8>, key: &'static mut Self::K, ) -> Result<(), (SubSliceMut<'static, u8>, &'static mut Self::K, ErrorCode)>

Generate key.

fn append_key( &self, key: &'static mut Self::K, value: SubSliceMut<'static, u8>, ) -> Result<(), (&'static mut [u8; 8], SubSliceMut<'static, u8>, ErrorCode)>

Appends the key/value pair.

fn get_value( &self, key: &'static mut Self::K, value: SubSliceMut<'static, u8>, ) -> Result<(), (&'static mut [u8; 8], SubSliceMut<'static, u8>, ErrorCode)>

Retrieves the value from a specified key.

fn invalidate_key( &self, key: &'static mut Self::K, ) -> Result<(), (&'static mut Self::K, ErrorCode)>

Invalidates the key in flash storage.

fn garbage_collect(&self) -> Result<(), ErrorCode>

Perform a garbage collection on the KV Store.