File tree 1 file changed +7
-4
lines changed
1 file changed +7
-4
lines changed Original file line number Diff line number Diff line change @@ -1274,11 +1274,12 @@ impl<T> Vec<T> {
1274
1274
/// Creates a draining iterator that removes the specified range in the vector
1275
1275
/// and yields the removed items.
1276
1276
///
1277
- /// Note 1: The element range is removed even if the iterator is only
1278
- /// partially consumed or not consumed at all.
1277
+ /// The element range is removed even if the iterator is only partially
1278
+ /// consumed or not consumed at all.
1279
1279
///
1280
- /// Note 2: It is unspecified how many elements are removed from the vector
1281
- /// if the `Drain` value is leaked.
1280
+ /// Note: Be aware that if the iterator is leaked (eg: [`mem::forget`]), it
1281
+ /// cancels this property so it is unspecified how many elements are removed
1282
+ /// from the vector in this case.
1282
1283
///
1283
1284
/// # Panics
1284
1285
///
@@ -1297,6 +1298,8 @@ impl<T> Vec<T> {
1297
1298
/// v.drain(..);
1298
1299
/// assert_eq!(v, &[]);
1299
1300
/// ```
1301
+ ///
1302
+ /// [`mem::forget`]: mem::forget
1300
1303
#[ stable( feature = "drain" , since = "1.6.0" ) ]
1301
1304
pub fn drain < R > ( & mut self , range : R ) -> Drain < ' _ , T >
1302
1305
where
You can’t perform that action at this time.
0 commit comments