rust/library/alloc/src
Matthias Krüger fa99ebc7cf
Rollup merge of #122817 - ultrabear:ultrabear_btreedoc, r=Nilstrieb
Doc Guarantee: BTree(Set|Map):  `IntoIter` Iterate in Sorted by key Order

This Doc-only PR adds text to the IntoIterator implementation and IntoIter type for both BTreeMap and BTreeSet that states that the returned items will be in sorted-by-key order, this is a guarantee that is made by the iter() and iter_mut() methods of BTreeMap/Set and BTreeMap respectively, but not on into_iter methods or types.

I don't know how the IntoIter iteration would not be sorted by key, and I would like to rely on that behavior for my prefix_array crate.

The text appended to IntoIter documentation is based on each types respective iter() method documentation, as is the text used in the IntoIterator documentation; they are slightly inconsistent between Set/Map, but they are consistent within their own types documentation.
2024-03-22 01:07:30 +01:00
..
alloc run alloc benchmarks in Miri and fix UB 2022-11-07 10:34:04 +01:00
boxed library: use addr_of! 2024-02-24 16:02:17 +03:00
collections document into_iter in top level docs iterator ordering guarantees 2024-03-21 02:07:46 -07:00
ffi Rollup merge of #112136 - clarfonthey:ffi-c_str, r=cuviper 2024-03-10 10:58:14 +01:00
raw_vec try_with_capacity for RawVec 2024-03-01 18:20:48 +00:00
rc remove redundant imports 2023-12-10 10:56:22 +08:00
slice ignore core, alloc and test tests that require unwinding on panic=abort 2023-06-13 15:53:24 +02:00
sync Fix some Arc allocator leaks 2024-01-28 18:33:34 +01:00
testing Share testing utilities with non-btree test cases 2022-05-02 10:07:50 +02:00
vec Auto merge of #122785 - the8472:const-select-specialized-impl, r=Amanieu 2024-03-21 21:19:19 +00:00
alloc.rs step cfgs 2024-03-20 08:49:13 -04:00
borrow.rs Add more diagnostic items for clippy 2023-10-05 18:21:47 -04:00
boxed.rs Only split by-ref/by-move futures for async closures 2024-03-19 16:59:23 -04:00
fmt.rs docs: use correct link, use secondary example 2024-02-12 20:17:47 -05:00
lib.rs Auto merge of #122055 - compiler-errors:stabilize-atb, r=oli-obk 2024-03-19 00:04:09 +00:00
macros.rs Update doc for alloc::format! and core::concat! 2023-09-06 15:11:21 +02:00
raw_vec.rs RawVec::into_box: avoid unnecessary intermediate reference 2024-03-10 18:07:34 +01:00
rc.rs Rollup merge of #121287 - zachs18:rc-into-raw-must-use, r=cuviper 2024-03-05 06:40:30 +01:00
slice.rs Add slice::try_range 2024-02-15 10:18:33 -05:00
str.rs Export core::str::from_raw_parts{,_mut} into alloc::str and std::str 2024-01-25 18:11:54 -08:00
string.rs try_with_capacity for Vec, VecDeque, String 2024-03-01 18:24:02 +00:00
sync.rs SeqCst->Relaxed in doc examples. 2024-03-19 15:27:11 +01:00
task.rs Generate original vtable and clone's vtable in the same CGU 2024-02-26 20:56:44 -08:00
tests.rs remove redundant imports 2023-12-10 10:56:22 +08:00