Skip to content

Clarify str::split_at docs #160595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rust-bors merged 1 commit into from
Aug 21, 2026
+14 −14
Merged

Clarify str::split_at docs #160595

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions library/core/src/str/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,13 +823,13 @@ impl str {
unsafe { &mut *(begin..end).get_unchecked_mut(self) }
}

/// Divides one string slice into two at an index.
/// Divides one string slice into two at a byte offset.
///
/// The argument, `mid`, should be a byte offset from the start of the
/// string. It must also be on the boundary of a UTF-8 code point.
///
/// The two slices returned go from the start of the string slice to `mid`,
/// and from `mid` to the end of the string slice.
/// The first returned slice contains exactly the first `mid` bytes, and the
/// second contains all remaining bytes.
///
/// To get mutable string slices instead, see the [`split_at_mut`]
/// method.
Expand Down Expand Up @@ -863,13 +863,13 @@ impl str {
}
}

/// Divides one mutable string slice into two at an index.
/// Divides one mutable string slice into two at a byte offset.
///
/// The argument, `mid`, should be a byte offset from the start of the
/// string. It must also be on the boundary of a UTF-8 code point.
///
/// The two slices returned go from the start of the string slice to `mid`,
/// and from `mid` to the end of the string slice.
/// The first returned slice contains exactly the first `mid` bytes, and the
/// second contains all remaining bytes.
///
/// To get immutable string slices instead, see the [`split_at`] method.
///
Expand Down Expand Up @@ -907,14 +907,14 @@ impl str {
}
}

/// Divides one string slice into two at an index.
/// Divides one string slice into two at a byte offset.
///
/// The argument, `mid`, should be a valid byte offset from the start of the
/// string. It must also be on the boundary of a UTF-8 code point. The
/// method returns `None` if that’s not the case.
///
/// The two slices returned go from the start of the string slice to `mid`,
/// and from `mid` to the end of the string slice.
/// The first returned slice contains exactly the first `mid` bytes, and the
/// second contains all remaining bytes.
///
/// To get mutable string slices instead, see the [`split_at_mut_checked`]
/// method.
Expand Down Expand Up @@ -947,14 +947,14 @@ impl str {
}
}

/// Divides one mutable string slice into two at an index.
/// Divides one mutable string slice into two at a byte offset.
///
/// The argument, `mid`, should be a valid byte offset from the start of the
/// string. It must also be on the boundary of a UTF-8 code point. The
/// method returns `None` if that’s not the case.
///
/// The two slices returned go from the start of the string slice to `mid`,
/// and from `mid` to the end of the string slice.
/// The first returned slice contains exactly the first `mid` bytes, and the
/// second contains all remaining bytes.
///
/// To get immutable string slices instead, see the [`split_at_checked`] method.
///
Expand Down Expand Up @@ -988,7 +988,7 @@ impl str {
}
}

/// Divides one string slice into two at an index.
/// Divides one string slice into two at a byte offset.
///
/// # Safety
///
Expand All @@ -1007,7 +1007,7 @@ impl str {
}
}

/// Divides one string slice into two at an index.
/// Divides one mutable string slice into two at a byte offset.
///
/// # Safety
///
Expand Down
Loading