Struct DefaultHashTable 

pub struct DefaultHashTable<TKey, TValue, TAllocator>
where
    TKey: Eq + Hash,
    TAllocator: Allocator,
{ /* private fields */ }

Represents the default hash table.

Notes

At the moment it uses BytellHashTable as the underlying implementation. This can change in the future though.

Implementations

impl<TKey, TValue, TAllocator> DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash, TAllocator: Allocator,

pub fn new() -> Self

Creates a new, empty DefaultHashTable with the default allocator.

pub fn with_allocator(allocator: TAllocator) -> Self

Creates a new, empty DefaultHashTable with the specified allocator.

pub fn with_capacity(capacity: Length) -> Result<Self, DefaultHashTableError>

Creates a new DefaultHashTable with the specified capacity and the default allocator.

This likely will (over)allocate memory.

Errors

See DefaultHashTableError for details.

pub fn with_capacity_and_allocator( capacity: Length, allocator: TAllocator, ) -> Result<Self, DefaultHashTableError>

Creates a new DefaultHashTable with the specified capacity and the specified allocator.

This likely will (over)allocate memory.

Errors

See DefaultHashTableError for details.

Trait Implementations

impl<TKey, TValue: Clone, TAllocator> Clone for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash + Clone, TAllocator: Allocator + Clone,

fn clone(&self) -> DefaultHashTable<TKey, TValue, TAllocator>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TKey, TValue, TAllocator> Default for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash, TAllocator: Allocator,

fn default() -> Self

Returns the “default value” for a type.

impl<TKey, TValue: Hash, TAllocator> Hash for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash + Hash, TAllocator: Allocator + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<TKey, TValue, TAllocator> ImmutableHashTable<TKey, TValue> for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash, TAllocator: Allocator,

fn length(&self) -> Length

Returns the number of (TKey, TValue) pairs the table contains. This typically does not correspond to the actual size of the table in bytes.

fn contains<Q>(&self, key: &Q) -> bool

where TKey: Borrow<Q>, Q: Eq + Hash + ?Sized,

Checks if the table contains the corresponding key.

fn get<Q>(&self, key: &Q) -> Option<&TValue>

where TKey: Borrow<Q>, Q: Eq + Hash + ?Sized,

Checks if the table contains the corresponding key, and if so then returns the reference to the TValue, or None otherwise.

fn get_key_value<Q>(&self, key: &Q) -> Option<(&TKey, &TValue)>

where TKey: Borrow<Q>, Q: Eq + Hash + ?Sized,

Checks if the table contains the corresponding key, and if so then returns the (&TKey, &TValue) pair or None otherwise.

fn iter<'a>(&'a self) -> impl Iterator<Item = (&'a TKey, &'a TValue)>

where TKey: 'a, TValue: 'a, Self: 'a,

Returns an iterator over the key-value pairs in the table.

fn is_empty(&self) -> bool

Checks if the table is empty. This does not mean that it doesn’t take space in memory. Equivalent to self.length() == 0 check.

impl<TKey, TValue, TAllocator> MutableHashTable<TKey, TValue> for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash, TAllocator: Allocator,

fn insert(&mut self, key: TKey, value: TValue) -> Option<TValue>

Inserts given (TKey, TValue) pair into the table.

fn remove_entry<Q>(&mut self, key: &Q) -> Option<(TKey, TValue)>

where TKey: Borrow<Q>, Q: Eq + Hash + ?Sized,

Removes entire entry from the table. Returns (TKey, TValue) pair for the matching key or None if there is no match.

fn insert_or_update_with<FAdd, FUpdate>( &mut self, key: TKey, adder: FAdd, updater: FUpdate, ) -> &mut TValue

where FAdd: FnOnce() -> TValue, FUpdate: FnOnce(&mut TValue),

Searches the table for a given key. If the table contains it, then it runs updater on the corresponding TValue. Otherwise runs adder to add a new TValue to the table. Returns the mutable reference to the final TValue.

fn iter_mut<'a>( &'a mut self, ) -> impl Iterator<Item = (&'a TKey, &'a mut TValue)>

where TKey: 'a, TValue: 'a, Self: 'a,

Returns a mutable iterator over the key-value pairs in the table.

fn remove<Q>(&mut self, key: &Q) -> Option<TValue>

where TKey: Borrow<Q>, Q: Eq + Hash + ?Sized,

Removes entire entry from the table. Similar to MutableHashTable::remove_entry, but returns TValue only for the matching key or None if there is no match.

fn get_or_insert_default(&mut self, key: TKey) -> &mut TValue

where TValue: Default,

Retrieves an existing TValue, or inserts a default one.

fn get_or_insert(&mut self, key: TKey, value: TValue) -> &mut TValue

Retrieves an existing TValue, or inserts the passed one.

impl<TKey, TValue: PartialEq, TAllocator> PartialEq for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash + PartialEq, TAllocator: Allocator + PartialEq,

fn eq(&self, other: &DefaultHashTable<TKey, TValue, TAllocator>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TKey, TValue, TAllocator> ReprC for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash + ReprC, TValue: ReprC, TAllocator: Allocator + ReprC,

const CHECK: ()

This field is used for const checks only.

impl<TKey, TValue: Eq, TAllocator> Eq for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash + Eq, TAllocator: Allocator + Eq,

impl<TKey, TValue, TAllocator> StructuralPartialEq for DefaultHashTable<TKey, TValue, TAllocator>

where TKey: Eq + Hash, TAllocator: Allocator,