pub struct HashSet<T, S = RandomState> { /* fields omitted */ }
A hash set implemented as a HashMap
where the value is ()
.
As with the HashMap
type, a HashSet
requires that the elements implement the Eq
and Hash
traits. This can frequently be achieved by using #[derive(PartialEq, Eq, Hash)]
. If you implement these yourself, it is important that the following property holds:
k1 == k2 -> hash(k1) == hash(k2)
In other words, if two keys are equal, their hashes must be equal.
It is a logic error for an item to be modified in such a way that the item's hash, as determined by the Hash
trait, or its equality, as determined by the Eq
trait, changes while it is in the set. This is normally only possible through Cell
, RefCell
, global state, I/O, or unsafe code.
use std::collections::HashSet; // Type inference lets us omit an explicit type signature (which // would be `HashSet<String>` in this example). let mut books = HashSet::new(); // Add some books. books.insert("A Dance With Dragons".to_string()); books.insert("To Kill a Mockingbird".to_string()); books.insert("The Odyssey".to_string()); books.insert("The Great Gatsby".to_string()); // Check for a specific one. if !books.contains("The Winds of Winter") { println!("We have {} books, but The Winds of Winter ain't one.", books.len()); } // Remove a book. books.remove("The Odyssey"); // Iterate over everything. for book in &books { println!("{}", book); }
The easiest way to use HashSet
with a custom type is to derive Eq
and Hash
. We must also derive PartialEq
, this will in the future be implied by Eq
.
use std::collections::HashSet; #[derive(Hash, Eq, PartialEq, Debug)] struct Viking { name: String, power: usize, } let mut vikings = HashSet::new(); vikings.insert(Viking { name: "Einar".to_string(), power: 9 }); vikings.insert(Viking { name: "Einar".to_string(), power: 9 }); vikings.insert(Viking { name: "Olaf".to_string(), power: 4 }); vikings.insert(Viking { name: "Harald".to_string(), power: 8 }); // Use derived implementation to print the vikings. for x in &vikings { println!("{:?}", x); }
A HashSet
with fixed list of elements can be initialized from an array:
use std::collections::HashSet; let viking_names: HashSet<&'static str> = [ "Einar", "Olaf", "Harald" ].iter().cloned().collect(); // use the values stored in the set
impl<T> HashSet<T, RandomState>
[src]
pub fn new() -> HashSet<T, RandomState>
[src]
Creates an empty HashSet
.
The hash set is initially created with a capacity of 0, so it will not allocate until it is first inserted into.
pub fn with_capacity(capacity: usize) -> HashSet<T, RandomState>
[src]
Creates an empty HashSet
with the specified capacity.
The hash set will be able to hold at least capacity
elements without reallocating. If capacity
is 0, the hash set will not allocate.
impl<T, S> HashSet<T, S>
[src]
pub fn capacity(&self) -> usize
[src]
Returns the number of elements the set can hold without reallocating.
pub fn iter(&self) -> Iter<'_, T>ⓘ
[src]
An iterator visiting all elements in arbitrary order. The iterator element type is &'a T
.
pub fn len(&self) -> usize
[src]
Returns the number of elements in the set.
pub fn is_empty(&self) -> bool
[src]
Returns true
if the set contains no elements.
pub fn drain(&mut self) -> Drain<'_, T>ⓘ
[src]1.6.0
Clears the set, returning all elements in an iterator.
pub fn clear(&mut self)
[src]
Clears the set, removing all values.
pub fn with_hasher(hasher: S) -> HashSet<T, S>
[src]1.7.0
Creates a new empty hash set which will use the given hasher to hash keys.
The hash set is also created with the default initial capacity.
Warning: hasher
is normally randomly generated, and is designed to allow HashSet
s to be resistant to attacks that cause many collisions and very poor performance. Setting it manually using this function can expose a DoS attack vector.
The hash_builder
passed should implement the BuildHasher
trait for the HashMap to be useful, see its documentation for details.
pub fn with_capacity_and_hasher(capacity: usize, hasher: S) -> HashSet<T, S>
[src]1.7.0
Creates an empty HashSet
with the specified capacity, using hasher
to hash the keys.
The hash set will be able to hold at least capacity
elements without reallocating. If capacity
is 0, the hash set will not allocate.
Warning: hasher
is normally randomly generated, and is designed to allow HashSet
s to be resistant to attacks that cause many collisions and very poor performance. Setting it manually using this function can expose a DoS attack vector.
The hash_builder
passed should implement the BuildHasher
trait for the HashMap to be useful, see its documentation for details.
pub fn hasher(&self) -> &SⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]1.9.0
Returns a reference to the set's BuildHasher
.
impl<T, S> HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher,
[src]
pub fn reserve(&mut self, additional: usize)
[src]
Reserves capacity for at least additional
more elements to be inserted in the HashSet
. The collection may reserve more space to avoid frequent reallocations.
Panics if the new allocation size overflows usize
.
pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>
[src]
Tries to reserve capacity for at least additional
more elements to be inserted in the given HashSet<K,V>
. The collection may reserve more space to avoid frequent reallocations.
If the capacity overflows, or the allocator reports a failure, then an error is returned.
pub fn shrink_to_fit(&mut self)
[src]
Shrinks the capacity of the set as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.
pub fn shrink_to(&mut self, min_capacity: usize)
[src]
Shrinks the capacity of the set with a lower limit. It will drop down no lower than the supplied limit while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.
Panics if the current capacity is smaller than the supplied minimum capacity.
pub fn difference<'a>(
&'a self,
other: &'a HashSet<T, S>
) -> Difference<'a, T, S>ⓘ
[src]
Visits the values representing the difference, i.e., the values that are in self
but not in other
.
use std::collections::HashSet; let a: HashSet<_> = [1, 2, 3].iter().cloned().collect(); let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect(); // Can be seen as `a - b`. for x in a.difference(&b) { println!("{}", x); // Print 1 } let diff: HashSet<_> = a.difference(&b).collect(); assert_eq!(diff, [1].iter().collect()); // Note that difference is not symmetric, // and `b - a` means something else: let diff: HashSet<_> = b.difference(&a).collect(); assert_eq!(diff, [4].iter().collect());
pub fn symmetric_difference<'a>(
&'a self,
other: &'a HashSet<T, S>
) -> SymmetricDifference<'a, T, S>ⓘ
[src]
Visits the values representing the symmetric difference, i.e., the values that are in self
or in other
but not in both.
use std::collections::HashSet; let a: HashSet<_> = [1, 2, 3].iter().cloned().collect(); let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect(); // Print 1, 4 in arbitrary order. for x in a.symmetric_difference(&b) { println!("{}", x); } let diff1: HashSet<_> = a.symmetric_difference(&b).collect(); let diff2: HashSet<_> = b.symmetric_difference(&a).collect(); assert_eq!(diff1, diff2); assert_eq!(diff1, [1, 4].iter().collect());
pub fn intersection<'a>(
&'a self,
other: &'a HashSet<T, S>
) -> Intersection<'a, T, S>ⓘ
[src]
Visits the values representing the intersection, i.e., the values that are both in self
and other
.
use std::collections::HashSet; let a: HashSet<_> = [1, 2, 3].iter().cloned().collect(); let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect(); // Print 2, 3 in arbitrary order. for x in a.intersection(&b) { println!("{}", x); } let intersection: HashSet<_> = a.intersection(&b).collect(); assert_eq!(intersection, [2, 3].iter().collect());
pub fn union<'a>(&'a self, other: &'a HashSet<T, S>) -> Union<'a, T, S>ⓘ
[src]
Visits the values representing the union, i.e., all the values in self
or other
, without duplicates.
use std::collections::HashSet; let a: HashSet<_> = [1, 2, 3].iter().cloned().collect(); let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect(); // Print 1, 2, 3, 4 in arbitrary order. for x in a.union(&b) { println!("{}", x); } let union: HashSet<_> = a.union(&b).collect(); assert_eq!(union, [1, 2, 3, 4].iter().collect());
pub fn contains<Q: ?Sized>(&self, value: &Q) -> bool where
T: Borrow<Q>,
Q: Hash + Eq,
[src]
Returns true
if the set contains a value.
The value may be any borrowed form of the set's value type, but Hash
and Eq
on the borrowed form must match those for the value type.
pub fn get<Q: ?Sized>(&self, value: &Q) -> Option<&T> where
T: Borrow<Q>,
Q: Hash + Eq,
[src]1.9.0
Returns a reference to the value in the set, if any, that is equal to the given value.
The value may be any borrowed form of the set's value type, but Hash
and Eq
on the borrowed form must match those for the value type.
pub fn get_or_insert(&mut self, value: T) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
Inserts the given value
into the set if it is not present, then returns a reference to the value in the set.
pub fn get_or_insert_owned<Q: ?Sized>(&mut self, value: &Q) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
T: Borrow<Q>,
Q: Hash + Eq + ToOwned<Owned = T>,
[src]
Inserts an owned copy of the given value
into the set if it is not present, then returns a reference to the value in the set.
#![feature(hash_set_entry)] use std::collections::HashSet; let mut set: HashSet<String> = ["cat", "dog", "horse"] .iter().map(|&pet| pet.to_owned()).collect(); assert_eq!(set.len(), 3); for &pet in &["cat", "dog", "fish"] { let value = set.get_or_insert_owned(pet); assert_eq!(value, pet); } assert_eq!(set.len(), 4); // a new "fish" was inserted
pub fn get_or_insert_with<Q: ?Sized, F>(&mut self, value: &Q, f: F) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
T: Borrow<Q>,
Q: Hash + Eq,
F: FnOnce(&Q) -> T,
[src]
Inserts a value computed from f
into the set if the given value
is not present, then returns a reference to the value in the set.
#![feature(hash_set_entry)] use std::collections::HashSet; let mut set: HashSet<String> = ["cat", "dog", "horse"] .iter().map(|&pet| pet.to_owned()).collect(); assert_eq!(set.len(), 3); for &pet in &["cat", "dog", "fish"] { let value = set.get_or_insert_with(pet, str::to_owned); assert_eq!(value, pet); } assert_eq!(set.len(), 4); // a new "fish" was inserted
pub fn is_disjoint(&self, other: &HashSet<T, S>) -> bool
[src]
Returns true
if self
has no elements in common with other
. This is equivalent to checking for an empty intersection.
pub fn is_subset(&self, other: &HashSet<T, S>) -> bool
[src]
Returns true
if the set is a subset of another, i.e., other
contains at least all the values in self
.
pub fn is_superset(&self, other: &HashSet<T, S>) -> bool
[src]
Returns true
if the set is a superset of another, i.e., self
contains at least all the values in other
.
pub fn insert(&mut self, value: T) -> bool
[src]
Adds a value to the set.
If the set did not have this value present, true
is returned.
If the set did have this value present, false
is returned.
pub fn replace(&mut self, value: T) -> Option<T>
[src]1.9.0
Adds a value to the set, replacing the existing value, if any, that is equal to the given one. Returns the replaced value.
pub fn remove<Q: ?Sized>(&mut self, value: &Q) -> bool where
T: Borrow<Q>,
Q: Hash + Eq,
[src]
Removes a value from the set. Returns whether the value was present in the set.
The value may be any borrowed form of the set's value type, but Hash
and Eq
on the borrowed form must match those for the value type.
pub fn take<Q: ?Sized>(&mut self, value: &Q) -> Option<T> where
T: Borrow<Q>,
Q: Hash + Eq,
[src]1.9.0
Removes and returns the value in the set, if any, that is equal to the given one.
The value may be any borrowed form of the set's value type, but Hash
and Eq
on the borrowed form must match those for the value type.
pub fn retain<F>(&mut self, f: F) where
F: FnMut(&T) -> bool,
[src]1.18.0
Retains only the elements specified by the predicate.
In other words, remove all elements e
such that f(&e)
returns false
.
impl<T, S, '_, '_> BitAnd<&'_ HashSet<T, S>> for &'_ HashSet<T, S> where
T: Eq + Hash + Clone,
S: BuildHasher + Default,
[src]
type Output = HashSet<T, S>
The resulting type after applying the &
operator.
fn bitand(self, rhs: &HashSet<T, S>) -> HashSet<T, S>
[src]
Returns the intersection of self
and rhs
as a new HashSet<T, S>
.
impl<T, S, '_, '_> BitOr<&'_ HashSet<T, S>> for &'_ HashSet<T, S> where
T: Eq + Hash + Clone,
S: BuildHasher + Default,
[src]
type Output = HashSet<T, S>
The resulting type after applying the |
operator.
fn bitor(self, rhs: &HashSet<T, S>) -> HashSet<T, S>
[src]
Returns the union of self
and rhs
as a new HashSet<T, S>
.
impl<T, S, '_, '_> BitXor<&'_ HashSet<T, S>> for &'_ HashSet<T, S> where
T: Eq + Hash + Clone,
S: BuildHasher + Default,
[src]
type Output = HashSet<T, S>
The resulting type after applying the ^
operator.
fn bitxor(self, rhs: &HashSet<T, S>) -> HashSet<T, S>
[src]
Returns the symmetric difference of self
and rhs
as a new HashSet<T, S>
.
impl<T: Clone, S: Clone> Clone for HashSet<T, S>
[src]
impl<T, S> Debug for HashSet<T, S> where
T: Debug,
[src]
impl<T, S> Default for HashSet<T, S> where
S: Default,
[src]
fn default() -> HashSet<T, S>
[src]
Creates an empty HashSet<T, S>
with the Default
value for the hasher.
impl<T, S> Eq for HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher,
[src]
impl<'a, T, S> Extend<&'a T> for HashSet<T, S> where
T: 'a + Eq + Hash + Copy,
S: BuildHasher,
[src]1.4.0
fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)
[src]
fn extend_one(&mut self, item: &'a T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T, S> Extend<T> for HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher,
[src]
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]
fn extend_one(&mut self, item: T)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]
impl<T, S> FromIterator<T> for HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher + Default,
[src]
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> HashSet<T, S>
[src]
impl<'a, T, S> IntoIterator for &'a HashSet<T, S>
[src]
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) -> Iter<'a, T>ⓘ
[src]
impl<T, S> IntoIterator for HashSet<T, S>
[src]
type Item = T
The type of the elements being iterated over.
type IntoIter = IntoIter<T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IntoIter<T>ⓘ
[src]
Creates a consuming iterator, that is, one that moves each value out of the set in arbitrary order. The set cannot be used after calling this.
use std::collections::HashSet; let mut set = HashSet::new(); set.insert("a".to_string()); set.insert("b".to_string()); // Not possible to collect to a Vec<String> with a regular `.iter()`. let v: Vec<String> = set.into_iter().collect(); // Will print in an arbitrary order. for x in &v { println!("{}", x); }
impl<T, S> PartialEq<HashSet<T, S>> for HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher,
[src]
impl<T, S, '_, '_> Sub<&'_ HashSet<T, S>> for &'_ HashSet<T, S> where
T: Eq + Hash + Clone,
S: BuildHasher + Default,
[src]
impl<T, S> RefUnwindSafe for HashSet<T, S> where
S: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, S> Send for HashSet<T, S> where
S: Send,
T: Send,
impl<T, S> Sync for HashSet<T, S> where
S: Sync,
T: Sync,
impl<T, S> Unpin for HashSet<T, S> where
S: Unpin,
T: Unpin,
impl<T, S> UnwindSafe for HashSet<T, S> where
S: UnwindSafe,
T: UnwindSafe,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<I> IntoIterator for I where
I: Iterator,
[src]
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/collections/struct.HashSet.html