1
Fork 0

Improved documentation for HashMap/BTreeMap Entry's .or_insert_with_key method

This commit is contained in:
Chai T. Rex 2020-12-07 21:36:01 -05:00
parent 866ef87d3f
commit f1b930d57c
2 changed files with 12 additions and 6 deletions

View file

@ -116,9 +116,12 @@ impl<'a, K: Ord, V> Entry<'a, K, V> {
} }
} }
/// Ensures a value is in the entry by inserting, if empty, the result of the default function, /// Ensures a value is in the entry by inserting, if empty, the result of the default function.
/// which takes the key as its argument, and returns a mutable reference to the value in the /// This method allows for generating key-derived values for insertion by providing the default
/// entry. /// function a reference to the key that was moved during the `.entry(key)` method call.<br />
///
/// The reference to the moved key is provided so that cloning or copying the key is
/// unnecessary, unlike with `.or_insert_with(|| ... )`.
/// ///
/// # Examples /// # Examples
/// ///

View file

@ -2222,9 +2222,12 @@ impl<'a, K, V> Entry<'a, K, V> {
} }
} }
/// Ensures a value is in the entry by inserting, if empty, the result of the default function, /// Ensures a value is in the entry by inserting, if empty, the result of the default function.
/// which takes the key as its argument, and returns a mutable reference to the value in the /// This method allows for generating key-derived values for insertion by providing the default
/// entry. /// function a reference to the key that was moved during the `.entry(key)` method call.
///
/// The reference to the moved key is provided so that cloning or copying the key is
/// unnecessary, unlike with `.or_insert_with(|| ... )`.
/// ///
/// # Examples /// # Examples
/// ///