Skip to main content

KvMap

Struct KvMap 

Source
pub struct KvMap<K: Copy + Eq + Send + Sync + 'static, V: Copy + Send + Sync + 'static> { /* private fields */ }
Expand description

Key-value lookup map, backed by SharedHashMap. Multiple processes can insert + look up concurrently via the shared MMF.

The dispatcher confirms SharedHashMap is the right family; if a different family is picked, the constructor returns ApiError::WrongFamily.

Implementations§

Source§

impl<K, V> KvMap<K, V>
where K: Copy + Eq + Hash + Send + Sync + 'static, V: Copy + Send + Sync + 'static,

Source

pub fn create( path: impl AsRef<Path>, shape: MmfWorkloadShape, capacity: usize, ) -> Result<Self, ApiError>

Create the map at path with the given workload shape. capacity is rounded up to next pow2.

Source

pub fn insert(&self, key: K, value: V) -> Result<InsertOutcome, ApiError>

Insert a key-value pair.

Source

pub fn get(&self, key: &K) -> Option<V>

Look up a value by key.

Source

pub fn len(&self) -> usize

Current number of occupied slots.

Source

pub fn is_empty(&self) -> bool

true if the map has no occupied slots.

Auto Trait Implementations§

§

impl<K, V> Freeze for KvMap<K, V>
where Arc<SharedHashMap<K, V>>: Freeze,

§

impl<K, V> RefUnwindSafe for KvMap<K, V>

§

impl<K, V> Send for KvMap<K, V>
where Arc<SharedHashMap<K, V>>: Send,

§

impl<K, V> Sync for KvMap<K, V>
where Arc<SharedHashMap<K, V>>: Sync,

§

impl<K, V> Unpin for KvMap<K, V>
where Arc<SharedHashMap<K, V>>: Unpin,

§

impl<K, V> UnsafeUnpin for KvMap<K, V>

§

impl<K, V> UnwindSafe for KvMap<K, V>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.