diff --git a/src/doc/unstable-book/src/library-features/entry-or-default.md b/src/doc/unstable-book/src/library-features/entry-or-default.md new file mode 100644 index 00000000000..f8c8a2a7a71 --- /dev/null +++ b/src/doc/unstable-book/src/library-features/entry-or-default.md @@ -0,0 +1,13 @@ +# `entry_or_default` + +The tracking issue for this feature is: [#44324] + +[#44324]: https://github.com/rust-lang/rust/issues/44324 + +------------------------ + +The `entry_or_default` feature adds a new method to `hash_map::Entry` +and `btree_map::Entry`, `or_default`, when `V: Default`. This method is +semantically identical to `or_insert_with(Default::default)`, and will +insert the default value for the type if no entry exists for the current +key. diff --git a/src/liballoc/btree/map.rs b/src/liballoc/btree/map.rs index f733c3332e2..4c93fead172 100644 --- a/src/liballoc/btree/map.rs +++ b/src/liballoc/btree/map.rs @@ -2104,6 +2104,33 @@ impl<'a, K: Ord, V> Entry<'a, K, V> { } } +impl<'a, K: Ord, V: Default> Entry<'a, K, V> { + #[unstable(feature = "entry_or_default", issue = "44324")] + /// Ensures a value is in the entry by inserting the default value if empty, + /// and returns a mutable reference to the value in the entry. + /// + /// # Examples + /// + /// ``` + /// #![feature(entry_or_default)] + /// # fn main() { + /// use std::collections::BTreeMap; + /// + /// let mut map: BTreeMap<&str, Option> = BTreeMap::new(); + /// map.entry("poneyland").or_default(); + /// + /// assert_eq!(map["poneyland"], None); + /// # } + /// ``` + pub fn or_default(self) -> &'a mut V { + match self { + Occupied(entry) => entry.into_mut(), + Vacant(entry) => entry.insert(Default::default()), + } + } + +} + impl<'a, K: Ord, V> VacantEntry<'a, K, V> { /// Gets a reference to the key that would be used when inserting a value /// through the VacantEntry. diff --git a/src/libstd/collections/hash/map.rs b/src/libstd/collections/hash/map.rs index 16b0c709986..fbb69ca9749 100644 --- a/src/libstd/collections/hash/map.rs +++ b/src/libstd/collections/hash/map.rs @@ -2001,6 +2001,33 @@ impl<'a, K, V> Entry<'a, K, V> { } } +impl<'a, K, V: Default> Entry<'a, K, V> { + #[unstable(feature = "entry_or_default", issue = "44324")] + /// Ensures a value is in the entry by inserting the default value if empty, + /// and returns a mutable reference to the value in the entry. + /// + /// # Examples + /// + /// ``` + /// #![feature(entry_or_default)] + /// # fn main() { + /// use std::collections::HashMap; + /// + /// let mut map: HashMap<&str, Option> = HashMap::new(); + /// map.entry("poneyland").or_default(); + /// + /// assert_eq!(map["poneyland"], None); + /// # } + /// ``` + pub fn or_default(self) -> &'a mut V { + match self { + Occupied(entry) => entry.into_mut(), + Vacant(entry) => entry.insert(Default::default()), + } + } + +} + impl<'a, K, V> OccupiedEntry<'a, K, V> { /// Gets a reference to the key in the entry. ///