Clarify documentation for string slicing (Index impls)
- Mention the sugared syntax for the implementations, since it's not apparent from the docs that `Index<Range<usize>>` corresponds to `&self[a..b]`. - Be specific in that start <= end and end <= len
This commit is contained in:
parent
c97524bef9
commit
55671a0290
@ -1313,13 +1313,19 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Implements substring slicing with syntax `&self[begin .. end]`.
|
||||
///
|
||||
/// Returns a slice of the given string from the byte range
|
||||
/// [`begin`..`end`).
|
||||
///
|
||||
/// This operation is `O(1)`.
|
||||
///
|
||||
/// Panics when `begin` and `end` do not point to valid characters
|
||||
/// or point beyond the last character of the string.
|
||||
/// # Panics
|
||||
///
|
||||
/// Panics if `begin` or `end` does not point to the starting
|
||||
/// byte offset of a character (as defined by `is_char_boundary`).
|
||||
/// Requires that `begin <= end` and `end <= len` where `len` is the
|
||||
/// length of the string.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
@ -1355,8 +1361,20 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Implements mutable substring slicing with syntax
|
||||
/// `&mut self[begin .. end]`.
|
||||
///
|
||||
/// Returns a mutable slice of the given string from the byte range
|
||||
/// [`begin`..`end`).
|
||||
///
|
||||
/// This operation is `O(1)`.
|
||||
///
|
||||
/// # Panics
|
||||
///
|
||||
/// Panics if `begin` or `end` does not point to the starting
|
||||
/// byte offset of a character (as defined by `is_char_boundary`).
|
||||
/// Requires that `begin <= end` and `end <= len` where `len` is the
|
||||
/// length of the string.
|
||||
#[stable(feature = "derefmut_for_string", since = "1.2.0")]
|
||||
impl ops::IndexMut<ops::Range<usize>> for str {
|
||||
#[inline]
|
||||
@ -1372,13 +1390,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a slice of the string from the beginning to byte
|
||||
/// Implements substring slicing with syntax `&self[.. end]`.
|
||||
///
|
||||
/// Returns a slice of the string from the beginning to byte offset
|
||||
/// `end`.
|
||||
///
|
||||
/// Equivalent to `self[0 .. end]`.
|
||||
///
|
||||
/// Panics when `end` does not point to a valid character, or is
|
||||
/// out of bounds.
|
||||
/// Equivalent to `&self[0 .. end]`.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl ops::Index<ops::RangeTo<usize>> for str {
|
||||
type Output = str;
|
||||
@ -1394,8 +1411,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a mutable slice of the string from the beginning to byte
|
||||
/// Implements mutable substring slicing with syntax `&mut self[.. end]`.
|
||||
///
|
||||
/// Returns a mutable slice of the string from the beginning to byte offset
|
||||
/// `end`.
|
||||
///
|
||||
/// Equivalent to `&mut self[0 .. end]`.
|
||||
#[stable(feature = "derefmut_for_string", since = "1.2.0")]
|
||||
impl ops::IndexMut<ops::RangeTo<usize>> for str {
|
||||
#[inline]
|
||||
@ -1409,12 +1430,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a slice of the string from `begin` to its end.
|
||||
/// Implements substring slicing with syntax `&self[begin ..]`.
|
||||
///
|
||||
/// Equivalent to `self[begin .. self.len()]`.
|
||||
/// Returns a slice of the string from byte offset `begin`
|
||||
/// to the end of the string.
|
||||
///
|
||||
/// Panics when `begin` does not point to a valid character, or is
|
||||
/// out of bounds.
|
||||
/// Equivalent to `&self[begin .. len]`.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl ops::Index<ops::RangeFrom<usize>> for str {
|
||||
type Output = str;
|
||||
@ -1430,7 +1451,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a slice of the string from `begin` to its end.
|
||||
/// Implements mutable substring slicing with syntax `&mut self[begin ..]`.
|
||||
///
|
||||
/// Returns a mutable slice of the string from byte offset `begin`
|
||||
/// to the end of the string.
|
||||
///
|
||||
/// Equivalent to `&mut self[begin .. len]`.
|
||||
#[stable(feature = "derefmut_for_string", since = "1.2.0")]
|
||||
impl ops::IndexMut<ops::RangeFrom<usize>> for str {
|
||||
#[inline]
|
||||
@ -1445,6 +1471,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Implements substring slicing with syntax `&self[..]`.
|
||||
///
|
||||
/// Returns a slice of the whole string. This operation can
|
||||
/// never panic.
|
||||
///
|
||||
/// Equivalent to `&self[0 .. len]`.
|
||||
#[stable(feature = "rust1", since = "1.0.0")]
|
||||
impl ops::Index<ops::RangeFull> for str {
|
||||
type Output = str;
|
||||
@ -1455,6 +1487,12 @@ mod traits {
|
||||
}
|
||||
}
|
||||
|
||||
/// Implements mutable substring slicing with syntax `&mut self[..]`.
|
||||
///
|
||||
/// Returns a mutable slice of the whole string. This operation can
|
||||
/// never panic.
|
||||
///
|
||||
/// Equivalent to `&mut self[0 .. len]`.
|
||||
#[stable(feature = "derefmut_for_string", since = "1.2.0")]
|
||||
impl ops::IndexMut<ops::RangeFull> for str {
|
||||
#[inline]
|
||||
|
Loading…
x
Reference in New Issue
Block a user