about summary refs log tree commit diff
path: root/library/alloc/src/vec
diff options
context:
space:
mode:
authorYOSHIOKA Takuma <nop_thread@nops.red>2022-08-10 01:51:38 +0900
committerYOSHIOKA Takuma <nop_thread@nops.red>2022-08-10 01:51:38 +0900
commit2bb7e1e6edf58c39faabb67cfab63dd8109d8055 (patch)
tree23f38608220364faa9a7b8887c70ca10d3cec27c /library/alloc/src/vec
parentcc4dd6fc9f1a5c798df269933c7e442b79661a86 (diff)
downloadrust-2bb7e1e6edf58c39faabb67cfab63dd8109d8055.tar.gz
rust-2bb7e1e6edf58c39faabb67cfab63dd8109d8055.zip
Guarantee `try_reserve` preserves the contents on error
Update doc comments to make the guarantee explicit. However, some
implementations does not have the statement though.

* `HashMap`, `HashSet`: require guarantees on hashbrown side.
* `PathBuf`: simply redirecting to `OsString`.

Fixes #99606.
Diffstat (limited to 'library/alloc/src/vec')
-rw-r--r--library/alloc/src/vec/mod.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs
index fa9f2131c0c..27027fa3a6f 100644
--- a/library/alloc/src/vec/mod.rs
+++ b/library/alloc/src/vec/mod.rs
@@ -875,7 +875,8 @@ impl<T, A: Allocator> Vec<T, A> {
     /// in the given `Vec<T>`. The collection may reserve more space to speculatively avoid
     /// frequent reallocations. After calling `try_reserve`, capacity will be
     /// greater than or equal to `self.len() + additional` if it returns
-    /// `Ok(())`. Does nothing if capacity is already sufficient.
+    /// `Ok(())`. Does nothing if capacity is already sufficient. This method
+    /// preserves the contents even if an error occurs.
     ///
     /// # Errors
     ///