bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #81919 - ssomers:btree_cleanup_comments, r=Mark-Simulacrum

Browse source 
BTreeMap: fix internal comments

Salvaged from #81372

r? `@Mark-Simulacrum`
This commit is contained in:
Dylan DPC 2021-02-14 16:54:49 +01:00 • committed by GitHub
commit 4e888bf403
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
library/alloc/src/collections/btree/navigate.rs
View file

@ -103,7 +103,8 @@ where
} }
} }
/// Equivalent to `range_search(k, v, ..)` but without the `Ord` bound. /// Equivalent to `range_search(root1, root2, ..)` but without the `Ord` bound.
/// Equivalent to `(root1.first_leaf_edge(), root2.last_leaf_edge())` but more efficient.
fn full_range<BorrowType: marker::BorrowType, K, V>( fn full_range<BorrowType: marker::BorrowType, K, V>(
root1: NodeRef<BorrowType, K, V, marker::LeafOrInternal>, root1: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
root2: NodeRef<BorrowType, K, V, marker::LeafOrInternal>, root2: NodeRef<BorrowType, K, V, marker::LeafOrInternal>,
@ -130,7 +131,7 @@ fn full_range<BorrowType: marker::BorrowType, K, V>(
} }
impl<'a, K: 'a, V: 'a> NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal> { impl<'a, K: 'a, V: 'a> NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal> {
/// Creates a pair of leaf edges delimiting a specified range in or underneath a node. /// Finds the pair of leaf edges delimiting a specific range in a tree.
/// ///
/// The result is meaningful only if the tree is ordered by key, like the tree /// The result is meaningful only if the tree is ordered by key, like the tree
/// in a `BTreeMap` is. /// in a `BTreeMap` is.
@ -149,7 +150,7 @@ impl<'a, K: 'a, V: 'a> NodeRef<marker::Immut<'a>, K, V, marker::LeafOrInternal>
range_search(self, self, range) range_search(self, self, range)
} }
/// Returns (self.first_leaf_edge(), self.last_leaf_edge()), but more efficiently. /// Finds the pair of leaf edges delimiting an entire tree.
pub fn full_range( pub fn full_range(
self, self,
) -> ( ) -> (

2
library/alloc/src/collections/btree/node.rs
View file

@ -181,7 +181,7 @@ impl<K, V, Type> NodeRef<marker::Owned, K, V, Type> {
NodeRef { height: self.height, node: self.node, _marker: PhantomData } NodeRef { height: self.height, node: self.node, _marker: PhantomData }
} }
/// Irreversibly transistions to a reference that offers traversal, /// Irreversibly transitions to a reference that permits traversal and offers
/// destructive methods and little else. /// destructive methods and little else.
pub fn into_dying(self) -> NodeRef<marker::Dying, K, V, Type> { pub fn into_dying(self) -> NodeRef<marker::Dying, K, V, Type> {
NodeRef { height: self.height, node: self.node, _marker: PhantomData } NodeRef { height: self.height, node: self.node, _marker: PhantomData }