Update BTreeSet::drain_filter documentation

This commit makes the documentation of `BTreeSet::drain_filter` more
consistent with that of `BTreeMap::drain_filter` after the changes in
f0b8166870.

In particular, this explicitly documents the iteration order.
This commit is contained in:
Janik Rabe 2021-07-01 21:56:10 +01:00
parent 64de4979e8
commit 3b2ad49a7a

View File

@ -941,18 +941,20 @@ impl<T> BTreeSet<T> {
BTreeSet { map: self.map.split_off(key) } BTreeSet { map: self.map.split_off(key) }
} }
/// Creates an iterator which uses a closure to determine if a value should be removed. /// Creates an iterator that visits all values in ascending order and uses a closure
/// to determine if a value should be removed.
/// ///
/// If the closure returns true, then the value is removed and yielded. /// If the closure returns `true`, the value is removed from the set and yielded. If
/// If the closure returns false, the value will remain in the list and will not be yielded /// the closure returns `false`, or panics, the value remains in the set and will
/// by the iterator. /// not be yielded.
/// ///
/// If the iterator is only partially consumed or not consumed at all, each of the remaining /// If the iterator is only partially consumed or not consumed at all, each of the
/// values will still be subjected to the closure and removed and dropped if it returns true. /// remaining values is still subjected to the closure and removed and dropped if it
/// returns `true`.
/// ///
/// It is unspecified how many more values will be subjected to the closure /// It is unspecified how many more values will be subjected to the closure if a
/// if a panic occurs in the closure, or if a panic occurs while dropping a value, or if the /// panic occurs in the closure, or if a panic occurs while dropping a value, or if
/// `DrainFilter` itself is leaked. /// the `DrainFilter` itself is leaked.
/// ///
/// # Examples /// # Examples
/// ///