Skip to content

Commit c527ec7

Browse files
committed
Improve Step docs
1 parent e61dcc7 commit c527ec7

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

library/core/src/iter/range.rs

+7-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ unsafe_impl_trusted_step![AsciiChar char i8 i16 i32 i64 i128 isize u8 u16 u32 u6
2222
///
2323
/// The *successor* operation moves towards values that compare greater.
2424
/// The *predecessor* operation moves towards values that compare lesser.
25-
#[unstable(feature = "step_trait", reason = "recently redesigned", issue = "42168")]
25+
#[unstable(feature = "step_trait", issue = "42168")]
2626
pub trait Step: Clone + PartialOrd + Sized {
2727
/// Returns the number of *successor* steps required to get from `start` to `end`.
2828
///
@@ -52,15 +52,12 @@ pub trait Step: Clone + PartialOrd + Sized {
5252
/// For any `a`, `n`, and `m`:
5353
///
5454
/// * `Step::forward_checked(a, n).and_then(|x| Step::forward_checked(x, m)) == Step::forward_checked(a, m).and_then(|x| Step::forward_checked(x, n))`
55-
///
56-
/// For any `a`, `n`, and `m` where `n + m` does not overflow:
57-
///
58-
/// * `Step::forward_checked(a, n).and_then(|x| Step::forward_checked(x, m)) == Step::forward_checked(a, n + m)`
55+
/// * `Step::forward_checked(a, n).and_then(|x| Step::forward_checked(x, m)) == try { Step::forward_checked(a, n.checked_add(m)) }`
5956
///
6057
/// For any `a` and `n`:
6158
///
6259
/// * `Step::forward_checked(a, n) == (0..n).try_fold(a, |x, _| Step::forward_checked(&x, 1))`
63-
/// * Corollary: `Step::forward_checked(&a, 0) == Some(a)`
60+
/// * Corollary: `Step::forward_checked(a, 0) == Some(a)`
6461
fn forward_checked(start: Self, count: usize) -> Option<Self>;
6562

6663
/// Returns the value that would be obtained by taking the *successor*
@@ -106,6 +103,7 @@ pub trait Step: Clone + PartialOrd + Sized {
106103
/// * if there exists `b` such that `b > a`, it is safe to call `Step::forward_unchecked(a, 1)`
107104
/// * if there exists `b`, `n` such that `steps_between(&a, &b) == Some(n)`,
108105
/// it is safe to call `Step::forward_unchecked(a, m)` for any `m <= n`.
106+
/// * Corollary: `Step::forward_unchecked(a, 0)` is always safe.
109107
///
110108
/// For any `a` and `n`, where no overflow occurs:
111109
///
@@ -128,8 +126,8 @@ pub trait Step: Clone + PartialOrd + Sized {
128126
///
129127
/// For any `a` and `n`:
130128
///
131-
/// * `Step::backward_checked(a, n) == (0..n).try_fold(a, |x, _| Step::backward_checked(&x, 1))`
132-
/// * Corollary: `Step::backward_checked(&a, 0) == Some(a)`
129+
/// * `Step::backward_checked(a, n) == (0..n).try_fold(a, |x, _| Step::backward_checked(x, 1))`
130+
/// * Corollary: `Step::backward_checked(a, 0) == Some(a)`
133131
fn backward_checked(start: Self, count: usize) -> Option<Self>;
134132

135133
/// Returns the value that would be obtained by taking the *predecessor*
@@ -175,6 +173,7 @@ pub trait Step: Clone + PartialOrd + Sized {
175173
/// * if there exists `b` such that `b < a`, it is safe to call `Step::backward_unchecked(a, 1)`
176174
/// * if there exists `b`, `n` such that `steps_between(&b, &a) == Some(n)`,
177175
/// it is safe to call `Step::backward_unchecked(a, m)` for any `m <= n`.
176+
/// * Corollary: `Step::backward_unchecked(a, 0)` is always safe.
178177
///
179178
/// For any `a` and `n`, where no overflow occurs:
180179
///

0 commit comments

Comments
 (0)