Skip to main content

HashIndex

Struct HashIndex 

Source
pub struct HashIndex<K: Hash + Eq, V: Copy> { /* private fields */ }
Expand description

A thread-safe hash index for O(1) key lookups.

Backed by FxHashMap with an RwLock - multiple readers, single writer. Best for exact-match queries on unique keys.

§Example

use grafeo_core::index::HashIndex;
use grafeo_common::types::NodeId;

let index: HashIndex<String, NodeId> = HashIndex::new();
index.insert("alice".to_string(), NodeId::new(1));
index.insert("bob".to_string(), NodeId::new(2));

assert_eq!(index.get(&"alice".to_string()), Some(NodeId::new(1)));

Implementations§

Source§

impl<K: Hash + Eq, V: Copy> HashIndex<K, V>

Source

pub fn new() -> Self

Creates a new empty hash index.

Source

pub fn with_capacity(capacity: usize) -> Self

Creates a new hash index with the given capacity.

Source

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

Inserts a key-value pair into the index.

Returns the previous value if the key was already present.

Source

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

Gets the value for a key.

Source

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

Removes a key from the index.

Returns the value if the key was present.

Source

pub fn contains(&self, key: &K) -> bool

Checks if a key exists in the index.

Source

pub fn len(&self) -> usize

Returns the number of entries in the index.

Source

pub fn is_empty(&self) -> bool

Returns true if the index is empty.

Source

pub fn clear(&self)

Clears all entries from the index.

Trait Implementations§

Source§

impl<K: Hash + Eq, V: Copy> Default for HashIndex<K, V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<K, V> !Freeze for HashIndex<K, V>

§

impl<K, V> !RefUnwindSafe for HashIndex<K, V>

§

impl<K, V> Send for HashIndex<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for HashIndex<K, V>
where K: Send + Sync, V: Send + Sync,

§

impl<K, V> Unpin for HashIndex<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnwindSafe for HashIndex<K, V>
where K: UnwindSafe, V: UnwindSafe,

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.