docs(clippy_utils): document StrIndex and its constructor#17026
Open
leno23 wants to merge 1 commit into
Open
Conversation
Describe when to use character vs byte indices and document `StrIndex::new`. Part of rust-lang#15569 Co-authored-by: Cursor <cursoragent@cursor.com>
rustbot
added
the
S-waiting-on-review
Collaborator
|
rustbot has assigned @samueltardieu. Use Why was this reviewer chosen?The reviewer was selected based on:
|
Collaborator
|
samueltardieu
requested changes
May 17, 2026
Comment on lines
+2
to
+5
| /// | ||
| /// Rust string slicing uses byte offsets, while many string algorithms reason | ||
| /// about character positions. Keeping both indices avoids accidental panics or | ||
| /// misaligned splits when working with non-ASCII text. |
Member
There was a problem hiding this comment.
This is useless, Clippy developers know that.
| } | ||
|
|
||
| impl StrIndex { | ||
| /// Creates an index pairing a UTF-8 byte offset with a character offset. |
Member
There was a problem hiding this comment.
This one us useless as well.
rustbot
added
S-waiting-on-author
Collaborator
|
Reminder, once the PR becomes ready for a review, use |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
StrIndexandStrIndex::newinclippy_utils::str_utils.Part of #15569
Made with Cursor