mikros/rust
1
0
Fork 0
Code Issues Pull Requests 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 /// eagerly skip `n` elements starting from the back by calling [`next_back`] up
/// to `n` times until [`None`] is encountered. /// to `n` times until [`None`] is encountered.
/// ///
/// `advance_back_by(n)` will return `0` if the iterator successfully advances by /// `advance_back_by(n)` will return `Ok(())` if the iterator successfully advances by
/// `n` elements, or an usize `k` if [`None`] is encountered, where `k` is remaining number /// `n` elements, or a `Err(NonZeroUsize)` with value `k` if [`None`] is encountered, where `k`
/// of steps that could not be advanced because the iterator ran out. /// is remaining number of steps that could not be advanced because the iterator ran out.
/// Note that `k` is always less than `n`. /// 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 /// 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 /// 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 @@ pub trait Iterator {
/// This method will eagerly skip `n` elements by calling [`next`] up to `n` /// This method will eagerly skip `n` elements by calling [`next`] up to `n`
/// times until [`None`] is encountered. /// times until [`None`] is encountered.
/// ///
/// `advance_by(n)` will return `0` if the iterator successfully advances by /// `advance_by(n)` will return `Ok(())` if the iterator successfully advances by
/// `n` elements, or an usize `k` if [`None`] is encountered, where `k` is remaining number /// `n` elements, or a `Err(NonZeroUsize)` with value `k` if [`None`] is encountered,
/// of steps that could not be advanced because the iterator ran out. /// 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`. /// 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`] /// 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 /// can advance its outer iterator until it finds an inner iterator that is not empty, which