Skip to content

Commit c67ff64

Browse files
committedNov 10, 2016
Add missing urls for FusedIterator and TrustedLen traits
1 parent 02aa428 commit c67ff64

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed
 

‎src/libcore/iter/traits.rs

+15-7
Original file line numberDiff line numberDiff line change
@@ -666,13 +666,17 @@ float_sum_product! { f32 f64 }
666666
/// An iterator that always continues to yield `None` when exhausted.
667667
///
668668
/// Calling next on a fused iterator that has returned `None` once is guaranteed
669-
/// to return `None` again. This trait is should be implemented by all iterators
669+
/// to return [`None`] again. This trait is should be implemented by all iterators
670670
/// that behave this way because it allows for some significant optimizations.
671671
///
672672
/// Note: In general, you should not use `FusedIterator` in generic bounds if
673-
/// you need a fused iterator. Instead, you should just call `Iterator::fused()`
674-
/// on the iterator. If the iterator is already fused, the additional `Fuse`
673+
/// you need a fused iterator. Instead, you should just call [`Iterator::fuse()`]
674+
/// on the iterator. If the iterator is already fused, the additional [`Fuse`]
675675
/// wrapper will be a no-op with no performance penalty.
676+
///
677+
/// [`None`]: ../../std/option/enum.Option.html#variant.None
678+
/// [`Iterator::fuse()`]: ../../std/iter/trait.Iterator.html#method.fuse
679+
/// [`Fuse`]: ../../std/iter/struct.Fuse.html
676680
#[unstable(feature = "fused", issue = "35602")]
677681
pub trait FusedIterator: Iterator {}
678682

@@ -682,16 +686,20 @@ impl<'a, I: FusedIterator + ?Sized> FusedIterator for &'a mut I {}
682686
/// An iterator that reports an accurate length using size_hint.
683687
///
684688
/// The iterator reports a size hint where it is either exact
685-
/// (lower bound is equal to upper bound), or the upper bound is `None`.
686-
/// The upper bound must only be `None` if the actual iterator length is
687-
/// larger than `usize::MAX`.
689+
/// (lower bound is equal to upper bound), or the upper bound is [`None`].
690+
/// The upper bound must only be [`None`] if the actual iterator length is
691+
/// larger than [`usize::MAX`].
688692
///
689693
/// The iterator must produce exactly the number of elements it reported.
690694
///
691695
/// # Safety
692696
///
693697
/// This trait must only be implemented when the contract is upheld.
694-
/// Consumers of this trait must inspect `.size_hint()`’s upper bound.
698+
/// Consumers of this trait must inspect [`.size_hint()`]’s upper bound.
699+
///
700+
/// [`None`]: ../../std/option/enum.Option.html#variant.None
701+
/// [`usize::MAX`]: ../../std/usize/constant.MAX.html
702+
/// [`.size_hint()`]: ../../std/iter/trait.Iterator.html#method.size_hint
695703
#[unstable(feature = "trusted_len", issue = "37572")]
696704
pub unsafe trait TrustedLen : Iterator {}
697705

0 commit comments

Comments
 (0)
Please sign in to comment.