f

Author: TheBlueMatt

lightning/src/util/indexed_map.rs

@@ -6,17 +6,19 @@ use core::ops::RangeBounds;
 
 /// A map which can be iterated in a deterministic order.
 ///
-/// This would traditionally be accomplished by simply using a `BTreeMap`, however B-Trees
+/// This would traditionally be accomplished by simply using a [`BTreeMap`], however B-Trees
 /// generally have very slow lookups. Because we use a nodes+channels map while finding routes
 /// across the network graph, our network graph backing map must be as performant as possible.
 /// However, because peers expect to sync the network graph from us (and we need to support that
 /// without holding a lock on the graph for the duration of the sync or dumping the entire graph
 /// into our outbound message queue), we need an iterable map with a consistent iteration order we
 /// can jump to a starting point on.
 ///
-/// Thus, we have a custom data structure here - its API mimics that of Rust's `BTreeMap`, but is
+/// Thus, we have a custom data structure here - its API mimics that of Rust's [`BTreeMap`], but is
 /// actually backed by a [`HashMap`], with some additional tracking to ensure we can iterate over
 /// keys in the order defined by [`Ord`].
+///
+/// [`BTreeMap`]: alloc::collections::BTreeMap
 #[derive(Clone, PartialEq, Eq)]
 pub struct IndexedMap<K: Ord, V> {
 	map: BTreeMap<K, V>,