weak_table

Struct PtrWeakHashSet

Source
pub struct PtrWeakHashSet<T, S = RandomState>(/* private fields */);
Expand description

A hash set with weak elements, hashed on element pointer.

When a weak pointer expires, its mapping is lazily removed.

Implementations§

Source§

impl<T: WeakElement> PtrWeakHashSet<T, RandomState>
where T::Strong: Deref,

Source

pub fn new() -> Self

Creates an empty PtrWeakHashSet.

O(1) time

Source

pub fn with_capacity(capacity: usize) -> Self

Creates an empty PtrWeakHashSet with the given capacity.

O(n) time

Source§

impl<T: WeakElement, S: BuildHasher> PtrWeakHashSet<T, S>
where T::Strong: Deref,

Source

pub fn with_hasher(hash_builder: S) -> Self

Creates an empty PtrWeakHashSet with the given capacity and hasher.

O(n) time

Source

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

Creates an empty PtrWeakHashSet with the given capacity and hasher.

O(n) time

Source

pub fn hasher(&self) -> &S

Returns a reference to the map’s BuildHasher.

O(1) time

Source

pub fn capacity(&self) -> usize

Returns the number of elements the map can hold without reallocating.

O(1) time

Source

pub fn remove_expired(&mut self)

Removes all mappings whose keys have expired.

O(n) time

Source

pub fn reserve(&mut self, additional_capacity: usize)

Reserves room for additional elements.

O(n) time

Source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity to the minimum allowed to hold the current number of elements.

O(n) time

Source

pub fn len(&self) -> usize

Returns an over-approximation of the number of elements.

O(1) time

Source

pub fn is_empty(&self) -> bool

Is the set known to be empty?

This could answer false for an empty set whose elements have expired but have yet to be collected.

O(1) time

Source

pub fn load_factor(&self) -> f32

The proportion of buckets that are used.

This is an over-approximation because of expired elements.

O(1) time

Source

pub fn clear(&mut self)

Removes all associations from the map.

O(n) time

Source

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

Returns true if the map contains the specified key.

expected O(1) time; worst-case O(p) time

Source

pub fn insert(&mut self, key: T::Strong) -> bool

Unconditionally inserts the value, returning the old value if already present. Does not replace the key.

expected O(1) time; worst-case O(p) time

Source

pub fn remove(&mut self, key: &T::Strong) -> bool

Removes the entry with the given key, if it exists, and returns the value.

expected O(1) time; worst-case O(p) time

Source

pub fn retain<F>(&mut self, f: F)
where F: FnMut(T::Strong) -> bool,

Removes all mappings not satisfying the given predicate.

Also removes any expired mappings.

O(n) time

Source

pub fn is_subset<S1>(&self, other: &PtrWeakHashSet<T, S1>) -> bool
where S1: BuildHasher,

Is self a subset of other?

expected O(n) time; worst-case O(nq) time (where n is self.capacity() and q is the length of the probe sequences in other)

Source§

impl<T: WeakElement, S> PtrWeakHashSet<T, S>
where T::Strong: Deref,

Source

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

Gets an iterator over the keys and values.

O(1) time

Source

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

Gets a draining iterator, which removes all the values but retains the storage.

O(1) time (and O(n) time to dispose of the result)

Trait Implementations§

Source§

impl<T: Clone, S: Clone> Clone for PtrWeakHashSet<T, S>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T, S> Debug for PtrWeakHashSet<T, S>
where T: WeakElement, T::Strong: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: WeakElement, S: BuildHasher + Default> Default for PtrWeakHashSet<T, S>
where T::Strong: Deref,

Source§

fn default() -> Self

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

impl<T, S> Extend<<T as WeakElement>::Strong> for PtrWeakHashSet<T, S>
where T: WeakElement, T::Strong: Deref, S: BuildHasher,

Source§

fn extend<I: IntoIterator<Item = T::Strong>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<T, S> FromIterator<<T as WeakElement>::Strong> for PtrWeakHashSet<T, S>

Source§

fn from_iter<I: IntoIterator<Item = T::Strong>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a, T: WeakElement, S> IntoIterator for &'a PtrWeakHashSet<T, S>
where T::Strong: Deref,

Source§

fn into_iter(self) -> Self::IntoIter

Creates a borrowing iterator from self.

O(1) time

Source§

type Item = <T as WeakElement>::Strong

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?
Source§

impl<T: WeakElement, S> IntoIterator for PtrWeakHashSet<T, S>

Source§

fn into_iter(self) -> Self::IntoIter

Creates an owning iterator from self.

O(1) time (and O(n) time to dispose of the result)

Source§

type Item = <T as WeakElement>::Strong

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?
Source§

impl<T, S, S1> PartialEq<PtrWeakHashSet<T, S1>> for PtrWeakHashSet<T, S>

Source§

fn eq(&self, other: &PtrWeakHashSet<T, S1>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T: WeakElement, S: BuildHasher> Eq for PtrWeakHashSet<T, S>
where T::Strong: Deref,

Auto Trait Implementations§

§

impl<T, S> Freeze for PtrWeakHashSet<T, S>
where S: Freeze,

§

impl<T, S> RefUnwindSafe for PtrWeakHashSet<T, S>

§

impl<T, S> Send for PtrWeakHashSet<T, S>
where S: Send, T: Send,

§

impl<T, S> Sync for PtrWeakHashSet<T, S>
where S: Sync, T: Sync,

§

impl<T, S> Unpin for PtrWeakHashSet<T, S>
where S: Unpin,

§

impl<T, S> UnwindSafe for PtrWeakHashSet<T, S>
where S: UnwindSafe, T: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.