languages/rust
languages/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust synced 2024-10-17 05:53:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation

Browse source
This commit is contained in:
The 8472 2023-03-13 20:16:43 +01:00
parent e29b27b4a4
commit 9cd9da2cd1
2 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
library/core/src/iter/traits/double_ended.rs
View file

@ -101,10 +101,11 @@ pub trait DoubleEndedIterator: Iterator {
/// eagerly skip `n` elements starting from the back by calling [`next_back`] up
/// to `n` times until [`None`] is encountered.
///
/// `advance_back_by(n)` will return `0` if the iterator successfully advances by
/// `n` elements, or an usize `k` if [`None`] is encountered, where `k` is remaining number
/// of steps that could not be advanced because the iterator ran out.
/// Note that `k` is always less than `n`.
/// `advance_back_by(n)` will return `Ok(())` if the iterator successfully advances by
/// `n` elements, or a `Err(NonZeroUsize)` with value `k` if [`None`] is encountered, where `k`
/// is remaining number of steps that could not be advanced because the iterator ran out.
/// If `self` is empty and `n` is non-zero, then this returns `Err(n)`.
/// Otherwise, `k` is always less than `n`.
///
/// Calling `advance_back_by(0)` can do meaningful work, for example [`Flatten`] can advance its
/// outer iterator until it finds an inner iterator that is not empty, which then often

9
library/core/src/iter/traits/iterator.rs
View file

@ -309,10 +309,11 @@ fn some<T>(_: Option<T>, x: T) -> Option<T> {
/// This method will eagerly skip `n` elements by calling [`next`] up to `n`
/// times until [`None`] is encountered.
///
/// `advance_by(n)` will return `0` if the iterator successfully advances by
/// `n` elements, or an usize `k` if [`None`] is encountered, where `k` is remaining number
/// of steps that could not be advanced because the iterator ran out.
/// Note that `k` is always less than `n`.
/// `advance_by(n)` will return `Ok(())` if the iterator successfully advances by
/// `n` elements, or a `Err(NonZeroUsize)` with value `k` if [`None`] is encountered,
/// where `k` is remaining number of steps that could not be advanced because the iterator ran out.
/// If `self` is empty and `n` is non-zero, then this returns `Err(n)`.
/// Otherwise, `k` is always less than `n`.
///
/// Calling `advance_by(0)` can do meaningful work, for example [`Flatten`]
/// can advance its outer iterator until it finds an inner iterator that is not empty, which