Struct AxDashSet 

pub struct AxDashSet<T, S = BuildHasherDefault<AxHasher>>(/* private fields */);

Concurrent hash set backed by dashmap (multi-shard RwLock) with AxHasher (AES-NI accelerated hashing) as the default hasher.

AxDashSet<T> is a thin newtype wrapper around DashSet<T> that adds ergonomic ::new() / ::with_capacity() / ::with_shard_amount() constructors. Every DashSet method is accessible transparently via Deref.

Implementations

impl<T> AxDashSet<T, BuildHasherDefault<AxHasher>>

where T: Hash + Eq,

pub fn new() -> Self

Creates an empty set with the default AxHasher and the default shard count.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty set pre-allocated for at least capacity entries.

impl<T, S> AxDashSet<T, S>

where T: Hash + Eq, S: BuildHasher + Clone,

pub fn with_hasher(hasher: S) -> Self

Creates an empty set using a custom BuildHasher.

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

Creates an empty set with at least capacity entries and a custom BuildHasher.

pub fn into_inner(self) -> RawDashSet<T, S>

Consumes the wrapper and returns the underlying RawDashSet.

Methods from Deref<Target = RawDashSet<T, S>>

pub fn hash_usize<T>(&self, item: &T) -> usize

where T: Hash,

Hash a given item to produce a usize. Uses the provided or default HashBuilder.

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

Inserts a key into the set. Returns true if the key was not already in the set.

Examples

use dashmap::DashSet;

let set = DashSet::new();
set.insert("I am the key!");

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

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

Removes an entry from the map, returning the key if it existed in the map.

Examples

use dashmap::DashSet;

let soccer_team = DashSet::new();
soccer_team.insert("Jack");
assert_eq!(soccer_team.remove("Jack").unwrap(), "Jack");

pub fn remove_if<Q>(&self, key: &Q, f: impl FnOnce(&K) -> bool) -> Option<K>

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

Removes an entry from the set, returning the key if the entry existed and the provided conditional function returned true.

use dashmap::DashSet;

let soccer_team = DashSet::new();
soccer_team.insert("Sam");
soccer_team.remove_if("Sam", |player| player.starts_with("Ja"));
assert!(soccer_team.contains("Sam"));

use dashmap::DashSet;

let soccer_team = DashSet::new();
soccer_team.insert("Sam");
soccer_team.remove_if("Jacob", |player| player.starts_with("Ja"));
assert!(!soccer_team.contains("Jacob"));

pub fn iter(&'a self) -> Iter<'a, K, S, DashMap<K, (), S>>

Creates an iterator over a DashMap yielding immutable references.

Examples

use dashmap::DashSet;

let words = DashSet::new();
words.insert("hello");
assert_eq!(words.iter().count(), 1);

pub fn get<Q>(&'a self, key: &Q) -> Option<Ref<'a, K>>

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

Get a reference to an entry in the set

Examples

use dashmap::DashSet;

let youtubers = DashSet::new();
youtubers.insert("Bosnian Bill");
assert_eq!(*youtubers.get("Bosnian Bill").unwrap(), "Bosnian Bill");

pub fn shrink_to_fit(&self)

Remove excess capacity to reduce memory usage.

pub fn retain(&self, f: impl FnMut(&K) -> bool)

Retain elements that whose predicates return true and discard elements whose predicates return false.

Examples

use dashmap::DashSet;

let people = DashSet::new();
people.insert("Albin");
people.insert("Jones");
people.insert("Charlie");
people.retain(|name| name.contains('i'));
assert_eq!(people.len(), 2);

pub fn len(&self) -> usize

Fetches the total number of keys stored in the set.

Examples

use dashmap::DashSet;

let people = DashSet::new();
people.insert("Albin");
people.insert("Jones");
people.insert("Charlie");
assert_eq!(people.len(), 3);

pub fn is_empty(&self) -> bool

Checks if the set is empty or not.

Examples

use dashmap::DashSet;

let map = DashSet::<()>::new();
assert!(map.is_empty());

pub fn clear(&self)

Removes all keys in the set.

Examples

use dashmap::DashSet;

let people = DashSet::new();
people.insert("Albin");
assert!(!people.is_empty());
people.clear();
assert!(people.is_empty());

pub fn capacity(&self) -> usize

Returns how many keys the set can store without reallocating.

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

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

Checks if the set contains a specific key.

Examples

use dashmap::DashSet;

let people = DashSet::new();
people.insert("Dakota Cherries");
assert!(people.contains("Dakota Cherries"));

Trait Implementations

impl<T, S> Debug for AxDashSet<T, S>

where T: Hash + Eq + Debug, S: BuildHasher + Clone,

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

Formats the value using the given formatter.

impl<T> Default for AxDashSet<T, BuildHasherDefault<AxHasher>>

where T: Hash + Eq,

fn default() -> Self

Returns the “default value” for a type.

impl<T, S> Deref for AxDashSet<T, S>

type Target = DashSet<T, S>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, S> DerefMut for AxDashSet<T, S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T, S> Extend<T> for AxDashSet<T, S>

where T: Hash + Eq, S: BuildHasher + Clone,

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl<T, S> From<AxDashSet<T, S>> for RawDashSet<T, S>

fn from(wrapper: AxDashSet<T, S>) -> Self

Converts to this type from the input type.

impl<T, S> From<DashSet<T, S>> for AxDashSet<T, S>

fn from(inner: RawDashSet<T, S>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for AxDashSet<T, BuildHasherDefault<AxHasher>>

where T: Hash + Eq,

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

Creates a value from an iterator.