Struct KeyedSet

pub struct KeyedSet<T, Extractor, S = DefaultHashBuilder> { /* private fields */ }

A HashMap<K, V> where K is a part of V

Implementations

impl<T, Extractor> KeyedSet<T, Extractor>

where Extractor: for<'a> KeyExtractor<'a, T>, for<'a> <Extractor as KeyExtractor<'a, T>>::Key: Hash,

pub fn new(extractor: Extractor) -> Self

Construct a new map where the key is extracted from the value using extractor.`

impl<T, Extractor, S> KeyedSet<T, Extractor, S>

where Extractor: for<'a> KeyExtractor<'a, T>, for<'a> <Extractor as KeyExtractor<'a, T>>::Key: Hash, S: BuildHasher,

pub fn insert(&mut self, value: T) -> Option<T>

where for<'a, 'b> <Extractor as KeyExtractor<'a, T>>::Key: PartialEq<<Extractor as KeyExtractor<'b, T>>::Key>,

Inserts a value into the map.

pub fn entry<'a, K>(&'a mut self, key: K) -> Entry<'a, T, Extractor, K, S>

where K: Hash, for<'z> <Extractor as KeyExtractor<'z, T>>::Key: Hash + PartialEq<K>,

Obtain an entry in the map, allowing mutable access to the value associated to that key if it exists.

pub fn write(&mut self, value: T) -> &mut T

where for<'a, 'b> <Extractor as KeyExtractor<'a, T>>::Key: PartialEq<<Extractor as KeyExtractor<'b, T>>::Key>,

Similar to KeyedSet::insert, but returns a mutable reference to the inserted value instead of the previous value.

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

where K: Hash, for<'a> <Extractor as KeyExtractor<'a, T>>::Key: Hash + PartialEq<K>,

Access the value associated to the key immutably.

pub fn get_mut<'a, K>( &'a mut self, key: &'a K, ) -> Option<KeyedSetGuard<'a, K, T, Extractor>>

where K: Hash, for<'z> <Extractor as KeyExtractor<'z, T>>::Key: Hash + PartialEq<K>,

Access the value associated to the key mutably.

The returned KeyedSetGuard will panic on drop if the value is modified in a way that modifies its key.

pub unsafe fn get_mut_unguarded<'a, K>( &'a mut self, key: &K, ) -> Option<&'a mut T>

where K: Hash, for<'z> <Extractor as KeyExtractor<'z, T>>::Key: Hash + PartialEq<K>,

Access the value associated to the key mutably.

Safety

Mutating the value in a way that mutates its key may lead to undefined behaviour.

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

where K: Hash, for<'z> <Extractor as KeyExtractor<'z, T>>::Key: Hash + PartialEq<K>,

Remove the value associated to the key, returning it if it exists.

pub fn drain_where<F: FnMut(&mut T) -> bool>( &mut self, predicate: F, ) -> DrainFilter<'_, T, F>

Returns an iterator that drains elements that match the provided predicate, while removing them from the set.

Note that DrainFilter WILL iterate fully on drop, ensuring that all elements matching your predicate are always removed, even if you fail to iterate.

pub fn drain(&mut self) -> Drain<'_, T>

Returns an iterator that drains elements from the collection, without affecting the collection’s capacity.

Note that Drain WILL iterate fully on drop, ensuring that all elements are indeed removed, even if you fail to iterate.

impl<T, Extractor, S> KeyedSet<T, Extractor, S>

pub fn iter(&self) -> Iter<'_, T>

Iterate over the KeyedSet’s values immutably.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Iterate over the KeyedSet’s values mutably.

pub fn len(&self) -> usize

Returns the number of elements in the KeyedSet

pub fn is_empty(&self) -> bool

Returns true if the KeyedSet is empty.

Trait Implementations

impl<T: Clone, Extractor: Clone, S: Clone> Clone for KeyedSet<T, Extractor, S>

fn clone(&self) -> KeyedSet<T, Extractor, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Extractor, S> Debug for KeyedSet<T, Extractor, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, Extractor: Default, S: Default> Default for KeyedSet<T, Extractor, S>

fn default() -> Self

Returns the “default value” for a type.

impl<T, Extractor, S, Borrower> IEntry<T, Extractor, S, Borrower> for KeyedSet<T, Extractor, S>

where Extractor: for<'a> KeyExtractor<'a, T>, for<'a> <Extractor as KeyExtractor<'a, T>>::Key: Hash, S: BuildHasher,

fn entry<'a, K>(&'a mut self, key: K) -> Entry<'a, T, Extractor, K, S>

where Borrower: IBorrower<K>, <Borrower as IBorrower<K>>::Borrowed: Hash, for<'z> <Extractor as KeyExtractor<'z, T>>::Key: Hash + PartialEq<<Borrower as IBorrower<K>>::Borrowed>,

Access the entry for key.

impl<'a, T, Extractor, S> IntoIterator for &'a KeyedSet<T, Extractor, S>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T, Extractor, S> IntoIterator for &'a mut KeyedSet<T, Extractor, S>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.