Trait ImmutableHashTable 

pub trait ImmutableHashTable<TKey, TValue>
where
    TKey: Hash + Eq,
{
    // Required methods
    fn length(&self) -> Length;
    fn contains<Q>(&self, key: &Q) -> bool
       where TKey: Borrow<Q>,
             Q: Eq + Hash + ?Sized;
    fn get<Q>(&self, key: &Q) -> Option<&TValue>
       where TKey: Borrow<Q>,
             Q: Eq + Hash + ?Sized;
    fn get_key_value<Q>(&self, key: &Q) -> Option<(&TKey, &TValue)>
       where TKey: Borrow<Q>,
             Q: Eq + Hash + ?Sized;
    fn iter<'a>(&'a self) -> impl Iterator<Item = (&'a TKey, &'a TValue)>
       where TKey: 'a,
             TValue: 'a,
             Self: 'a;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

Represents an immutable hash table.

Required Methods

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.

Notes

The borrowed Q type’s Hash and Eq must match those for TKey.

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.

Notes

The borrowed Q type’s Hash and Eq must match those for TKey.

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.

Notes

The borrowed Q type’s Hash and Eq must match those for TKey.

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.

Notes

The iterator yields (&TKey, &TValue) tuples representing each key-value pair in the hash table.

Provided Methods

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.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<TKey, TValue> ImmutableHashTable<TKey, TValue> for HashMap<TKey, TValue>

where TKey: Hash + Eq,

Available on crate feature std only.

fn length(&self) -> Length

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

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

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

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

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

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

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

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

Implementors

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

where TKey: Eq + Hash, TAllocator: Allocator,

impl<TKey, TValue, TConfig> ImmutableHashTable<TKey, TValue> for BytellHashTable<TKey, TValue, TConfig>

where TKey: Eq + Hash, TConfig: BytellConfig,