@@ -262,7 +262,13 @@ impl<K, Q: ?Sized> super::Recover<Q> for BTreeMap<K, ()>
262
262
}
263
263
}
264
264
265
- /// An iterator over a `BTreeMap`'s entries.
265
+ /// An iterator over the entries of a `BTreeMap`.
266
+ ///
267
+ /// This `struct` is created by the [`iter`] method on [`BTreeMap`]. See its
268
+ /// documentation for more.
269
+ ///
270
+ /// [`iter`]: struct.BTreeMap.html#method.iter
271
+ /// [`BTreeMap`]: struct.BTreeMap.html
266
272
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
267
273
pub struct Iter < ' a , K : ' a , V : ' a > {
268
274
range : Range < ' a , K , V > ,
@@ -276,15 +282,27 @@ impl<'a, K: 'a + fmt::Debug, V: 'a + fmt::Debug> fmt::Debug for Iter<'a, K, V> {
276
282
}
277
283
}
278
284
279
- /// A mutable iterator over a `BTreeMap`'s entries.
285
+ /// A mutable iterator over the entries of a `BTreeMap`.
286
+ ///
287
+ /// This `struct` is created by the [`iter_mut`] method on [`BTreeMap`]. See its
288
+ /// documentation for more.
289
+ ///
290
+ /// [`iter_mut`]: struct.BTreeMap.html#method.iter_mut
291
+ /// [`BTreeMap`]: struct.BTreeMap.html
280
292
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
281
293
#[ derive( Debug ) ]
282
294
pub struct IterMut < ' a , K : ' a , V : ' a > {
283
295
range : RangeMut < ' a , K , V > ,
284
296
length : usize ,
285
297
}
286
298
287
- /// An owning iterator over a `BTreeMap`'s entries.
299
+ /// An owning iterator over the entries of a `BTreeMap`.
300
+ ///
301
+ /// This `struct` is created by the [`into_iter`] method on [`BTreeMap`]
302
+ /// (provided by the `IntoIterator` trait). See its documentation for more.
303
+ ///
304
+ /// [`into_iter`]: struct.BTreeMap.html#method.into_iter
305
+ /// [`BTreeMap`]: struct.BTreeMap.html
288
306
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
289
307
pub struct IntoIter < K , V > {
290
308
front : Handle < NodeRef < marker:: Owned , K , V , marker:: Leaf > , marker:: Edge > ,
@@ -303,7 +321,13 @@ impl<K: fmt::Debug, V: fmt::Debug> fmt::Debug for IntoIter<K, V> {
303
321
}
304
322
}
305
323
306
- /// An iterator over a `BTreeMap`'s keys.
324
+ /// An iterator over the keys of a `BTreeMap`.
325
+ ///
326
+ /// This `struct` is created by the [`keys`] method on [`BTreeMap`]. See its
327
+ /// documentation for more.
328
+ ///
329
+ /// [`keys`]: struct.BTreeMap.html#method.keys
330
+ /// [`BTreeMap`]: struct.BTreeMap.html
307
331
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
308
332
pub struct Keys < ' a , K : ' a , V : ' a > {
309
333
inner : Iter < ' a , K , V > ,
@@ -316,7 +340,13 @@ impl<'a, K: 'a + fmt::Debug, V: 'a + fmt::Debug> fmt::Debug for Keys<'a, K, V> {
316
340
}
317
341
}
318
342
319
- /// An iterator over a `BTreeMap`'s values.
343
+ /// An iterator over the values of a `BTreeMap`.
344
+ ///
345
+ /// This `struct` is created by the [`values`] method on [`BTreeMap`]. See its
346
+ /// documentation for more.
347
+ ///
348
+ /// [`values`]: struct.BTreeMap.html#method.values
349
+ /// [`BTreeMap`]: struct.BTreeMap.html
320
350
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
321
351
pub struct Values < ' a , K : ' a , V : ' a > {
322
352
inner : Iter < ' a , K , V > ,
@@ -329,14 +359,26 @@ impl<'a, K: 'a + fmt::Debug, V: 'a + fmt::Debug> fmt::Debug for Values<'a, K, V>
329
359
}
330
360
}
331
361
332
- /// A mutable iterator over a `BTreeMap`'s values.
362
+ /// A mutable iterator over the values of a `BTreeMap`.
363
+ ///
364
+ /// This `struct` is created by the [`values_mut`] method on [`BTreeMap`]. See its
365
+ /// documentation for more.
366
+ ///
367
+ /// [`values_mut`]: struct.BTreeMap.html#method.values_mut
368
+ /// [`BTreeMap`]: struct.BTreeMap.html
333
369
#[ stable( feature = "map_values_mut" , since = "1.10.0" ) ]
334
370
#[ derive( Debug ) ]
335
371
pub struct ValuesMut < ' a , K : ' a , V : ' a > {
336
372
inner : IterMut < ' a , K , V > ,
337
373
}
338
374
339
- /// An iterator over a sub-range of `BTreeMap`'s entries.
375
+ /// An iterator over a sub-range of entries in a `BTreeMap`.
376
+ ///
377
+ /// This `struct` is created by the [`range`] method on [`BTreeMap`]. See its
378
+ /// documentation for more.
379
+ ///
380
+ /// [`range`]: struct.BTreeMap.html#method.range
381
+ /// [`BTreeMap`]: struct.BTreeMap.html
340
382
#[ stable( feature = "btree_range" , since = "1.17.0" ) ]
341
383
pub struct Range < ' a , K : ' a , V : ' a > {
342
384
front : Handle < NodeRef < marker:: Immut < ' a > , K , V , marker:: Leaf > , marker:: Edge > ,
@@ -350,7 +392,13 @@ impl<'a, K: 'a + fmt::Debug, V: 'a + fmt::Debug> fmt::Debug for Range<'a, K, V>
350
392
}
351
393
}
352
394
353
- /// A mutable iterator over a sub-range of `BTreeMap`'s entries.
395
+ /// A mutable iterator over a sub-range of entries in a `BTreeMap`.
396
+ ///
397
+ /// This `struct` is created by the [`range_mut`] method on [`BTreeMap`]. See its
398
+ /// documentation for more.
399
+ ///
400
+ /// [`range_mut`]: struct.BTreeMap.html#method.range_mut
401
+ /// [`BTreeMap`]: struct.BTreeMap.html
354
402
#[ stable( feature = "btree_range" , since = "1.17.0" ) ]
355
403
pub struct RangeMut < ' a , K : ' a , V : ' a > {
356
404
front : Handle < NodeRef < marker:: Mut < ' a > , K , V , marker:: Leaf > , marker:: Edge > ,
@@ -372,18 +420,19 @@ impl<'a, K: 'a + fmt::Debug, V: 'a + fmt::Debug> fmt::Debug for RangeMut<'a, K,
372
420
}
373
421
374
422
/// A view into a single entry in a map, which may either be vacant or occupied.
375
- /// This enum is constructed from the [`entry`] method on [`BTreeMap`].
423
+ ///
424
+ /// This `enum` is constructed from the [`entry`] method on [`BTreeMap`].
376
425
///
377
426
/// [`BTreeMap`]: struct.BTreeMap.html
378
427
/// [`entry`]: struct.BTreeMap.html#method.entry
379
428
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
380
429
pub enum Entry < ' a , K : ' a , V : ' a > {
381
- /// A vacant `Entry`
430
+ /// A vacant entry.
382
431
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
383
432
Vacant ( #[ stable( feature = "rust1" , since = "1.0.0" ) ]
384
433
VacantEntry < ' a , K , V > ) ,
385
434
386
- /// An occupied `Entry`
435
+ /// An occupied entry.
387
436
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
388
437
Occupied ( #[ stable( feature = "rust1" , since = "1.0.0" ) ]
389
438
OccupiedEntry < ' a , K , V > ) ,
@@ -403,7 +452,8 @@ impl<'a, K: 'a + Debug + Ord, V: 'a + Debug> Debug for Entry<'a, K, V> {
403
452
}
404
453
}
405
454
406
- /// A vacant `Entry`. It is part of the [`Entry`] enum.
455
+ /// A view into a vacant entry in a `BTreeMap`.
456
+ /// It is part of the [`Entry`] enum.
407
457
///
408
458
/// [`Entry`]: enum.Entry.html
409
459
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
@@ -425,7 +475,8 @@ impl<'a, K: 'a + Debug + Ord, V: 'a> Debug for VacantEntry<'a, K, V> {
425
475
}
426
476
}
427
477
428
- /// An occupied `Entry`. It is part of the [`Entry`] enum.
478
+ /// A view into an occupied entry in a `BTreeMap`.
479
+ /// It is part of the [`Entry`] enum.
429
480
///
430
481
/// [`Entry`]: enum.Entry.html
431
482
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
0 commit comments