Struct capsules_extra::kv_driver::KVStoreDriver

pub struct KVStoreDriver<'a, V: KVPermissions<'a>> { /* private fields */ }

Capsule that provides userspace access to a key-value store.

Implementations

impl<'a, V: KVPermissions<'a>> KVStoreDriver<'a, V>

pub fn new( kv: &'a V, key_buffer: &'static mut [u8], value_buffer: &'static mut [u8], grant: Grant<App, UpcallCount<{ upcalls::COUNT }>, AllowRoCount<{ ro_allow::COUNT }>, AllowRwCount<{ rw_allow::COUNT }>>, ) -> KVStoreDriver<'a, V>

Trait Implementations

impl<'a, V: KVPermissions<'a>> KVClient for KVStoreDriver<'a, V>

fn get_complete( &self, result: Result<(), ErrorCode>, key: SubSliceMut<'static, u8>, value: SubSliceMut<'static, u8>, )

This callback is called when the get operation completes.

fn set_complete( &self, result: Result<(), ErrorCode>, key: SubSliceMut<'static, u8>, value: SubSliceMut<'static, u8>, )

This callback is called when the set operation completes.

fn add_complete( &self, result: Result<(), ErrorCode>, key: SubSliceMut<'static, u8>, value: SubSliceMut<'static, u8>, )

This callback is called when the add operation completes.

fn update_complete( &self, result: Result<(), ErrorCode>, key: SubSliceMut<'static, u8>, value: SubSliceMut<'static, u8>, )

This callback is called when the update operation completes.

fn delete_complete( &self, result: Result<(), ErrorCode>, key: SubSliceMut<'static, u8>, )

This callback is called when the delete operation completes.

impl<'a, V: KVPermissions<'a>> SyscallDriver for KVStoreDriver<'a, V>

fn command( &self, command_num: usize, _data1: usize, _data2: usize, processid: ProcessId, ) -> CommandReturn

System call for a process to perform a short synchronous operation or start a long-running split-phase operation (whose completion is signaled with an upcall). Command 0 is a reserved command to detect if a peripheral system call driver is installed and must always return a CommandReturn::success.

fn allocate_grant(&self, processid: ProcessId) -> Result<(), Error>

Request to allocate a capsule’s grant for a specific process.

fn allow_userspace_readable( &self, app: ProcessId, which: usize, slice: ReadWriteProcessBuffer, ) -> Result<ReadWriteProcessBuffer, (ReadWriteProcessBuffer, ErrorCode)>

System call for a process to pass a buffer (a UserspaceReadableProcessBuffer) to the kernel that the kernel can either read or write. The kernel calls this method only after it checks that the entire buffer is within memory the process can both read and write.