]> git.lizzy.rs Git - rust.git/commitdiff
Rollup merge of #34975 - GuillaumeGomez:random_state_doc, r=steveklabnik
authorManish Goregaokar <manishsmail@gmail.com>
Sun, 24 Jul 2016 09:48:47 +0000 (15:18 +0530)
committerGitHub <noreply@github.com>
Sun, 24 Jul 2016 09:48:47 +0000 (15:18 +0530)
Add Random state doc

Last part of #29348.

r? @steveklabnik

src/libstd/collections/hash/map.rs

index a03249e0063568b38ec49ee378e021a8d6b72c2f..ed5ac3bc0c1605773a46052603da33761f8582cc 100644 (file)
@@ -1699,6 +1699,17 @@ fn extend<T: IntoIterator<Item=(&'a K, &'a V)>>(&mut self, iter: T) {
 /// A particular instance `RandomState` will create the same instances of
 /// `Hasher`, but the hashers created by two different `RandomState`
 /// instances are unlikely to produce the same result for the same values.
+///
+/// # Examples
+///
+/// ```
+/// use std::collections::HashMap;
+/// use std::collections::hash_map::RandomState;
+///
+/// let s = RandomState::new();
+/// let mut map = HashMap::with_hasher(s);
+/// map.insert(1, 2);
+/// ```
 #[derive(Clone)]
 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
 pub struct RandomState {
@@ -1708,6 +1719,14 @@ pub struct RandomState {
 
 impl RandomState {
     /// Constructs a new `RandomState` that is initialized with random keys.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::collections::hash_map::RandomState;
+    ///
+    /// let s = RandomState::new();
+    /// ```
     #[inline]
     #[allow(deprecated)] // rand
     #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]