Struct horde::sync_table::SyncTable

pub struct SyncTable<K, V, S = DefaultHashBuilder> { /* fields omitted */ }

A hash table with lock-free reads.

It is based on the table from the hashbrown crate.

Implementations

impl<K, V> SyncTable<K, V, DefaultHashBuilder>

pub fn new() -> Self

Creates an empty SyncTable.

The hash map is initially created with a capacity of 0, so it will not allocate until it is first inserted into.

impl<K, V, S> SyncTable<K, V, S>

pub fn new_with(hash_builder: S, capacity: usize) -> Self

Creates an empty SyncTable with the specified capacity, using hash_builder to hash the elements or keys.

The hash map will be able to hold at least capacity elements without reallocating. If capacity is 0, the hash map will not allocate.

pub fn hasher(&self) -> &S

Returns a reference to the table’s BuildHasher.

pub fn mutex(&self) -> &Mutex<()>

Gets a reference to the underlying mutex that protects writes.

pub fn read<'a>(&'a self, pin: Pin<'a>) -> Read<'a, K, V, S>

Creates a Read handle from a pinned region.

Use crate::collect::pin to get a Pin instance.

pub unsafe fn unsafe_write(&self) -> Write<'_, K, V, S>

Creates a Write handle without checking for exclusive access.

Safety

It’s up to the caller to ensure only one thread writes to the vector at a time.

pub fn write(&mut self) -> Write<'_, K, V, S>

Creates a Write handle from a mutable reference.

pub fn lock(&self) -> LockedWrite<'_, K, V, S>

Creates a LockedWrite handle by taking the underlying mutex that protects writes.

pub fn lock_from_guard<'a>(
    &'a self,
    guard: MutexGuard<'a, ()>
) -> LockedWrite<'a, K, V, S>

Creates a LockedWrite handle from a guard protecting the underlying mutex that protects writes.

impl<K, V, S: BuildHasher> SyncTable<K, V, S>

pub fn hash_key<Q: ?Sized>(&self, key: &Q) -> u64 where
    K: Borrow<Q>,
    Q: Hash, 

Hashes a key with the table’s hasher.

pub fn get_mut<Q: ?Sized>(
    &mut self,
    key: &Q,
    hash: Option<u64>
) -> Option<(&mut K, &mut V)> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Gets a mutable reference to an element in the table.

Trait Implementations

impl<K: Hash + Clone, V: Clone, S: Clone + BuildHasher> Clone for SyncTable<K, V, S>

fn clone(&self) -> SyncTable<K, V, S>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K, V, S: Default> Default for SyncTable<K, V, S>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, S> Drop for SyncTable<K, V, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<K: Eq + Hash + Clone + Send, V: Clone + Send, S: BuildHasher + Default> FromIterator<(K, V)> for SyncTable<K, V, S>

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<K: Send, V: Send, S: Send> Send for SyncTable<K, V, S>

impl<K: Sync, V: Sync, S: Sync> Sync for SyncTable<K, V, S>