diff options
| author | Corey Farwell <coreyf@rwell.org> | 2017-08-01 08:12:01 -0400 |
|---|---|---|
| committer | Corey Farwell <coreyf@rwell.org> | 2017-08-01 19:51:00 -0400 |
| commit | d9df2963ad40b67aecde95cbfe98599a45351352 (patch) | |
| tree | 27ea1d80c37499a90a77abc4c889fb11e6845728 /src/libstd | |
| parent | 34c1bfb0e142587bbbede848b69b2d498b8ede34 (diff) | |
| download | rust-d9df2963ad40b67aecde95cbfe98599a45351352.tar.gz rust-d9df2963ad40b67aecde95cbfe98599a45351352.zip | |
Add doc example for HashSet::drain.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/collections/hash/set.rs | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libstd/collections/hash/set.rs b/src/libstd/collections/hash/set.rs index 3c39db3fbab..80a223c7d74 100644 --- a/src/libstd/collections/hash/set.rs +++ b/src/libstd/collections/hash/set.rs @@ -453,6 +453,22 @@ impl<T, S> HashSet<T, S> } /// Clears the set, returning all elements in an iterator. + /// + /// # Examples + /// + /// ``` + /// use std::collections::HashSet; + /// + /// let mut set: HashSet<_> = [1, 2, 3].iter().cloned().collect(); + /// assert!(!set.is_empty()); + /// + /// // print 1, 2, 3 in an arbitrary order + /// for i in set.drain() { + /// println!("{}", i); + /// } + /// + /// assert!(set.is_empty()); + /// ``` #[inline] #[stable(feature = "drain", since = "1.6.0")] pub fn drain(&mut self) -> Drain<T> { |