mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #132398 - krtab:add_doc_link, r=Noratrieb

Browse Source 
Add a couple of intra-doc links to str
This commit is contained in:
Matthias Krüger 2024-11-02 08:33:11 +01:00 committed by GitHub
commit ec1cebfcb6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
library/core/src/str/mod.rs
View File

@ -212,7 +212,7 @@ pub const fn is_char_boundary(&self, index: usize) -> bool {
}
}
/// Finds the closest `x` not exceeding `index` where `is_char_boundary(x)` is `true`.
/// Finds the closest `x` not exceeding `index` where [`is_char_boundary(x)`] is `true`.
///
/// This method can help you truncate a string so that it's still valid UTF-8, but doesn't
/// exceed a given number of bytes. Note that this is done purely at the character level
@ -220,6 +220,8 @@ pub const fn is_char_boundary(&self, index: usize) -> bool {
/// split. For example, the emoji 🧑‍🔬 (scientist) could be split so that the string only
/// includes 🧑 (person) instead.
///
/// [`is_char_boundary(x)`]: Self::is_char_boundary
///
/// # Examples
///
/// ```
@ -248,7 +250,7 @@ pub fn floor_char_boundary(&self, index: usize) -> usize {
}
}
/// Finds the closest `x` not below `index` where `is_char_boundary(x)` is `true`.
/// Finds the closest `x` not below `index` where [`is_char_boundary(x)`] is `true`.
///
/// If `index` is greater than the length of the string, this returns the length of the string.
///
@ -256,7 +258,7 @@ pub fn floor_char_boundary(&self, index: usize) -> usize {
/// for more details.
///
/// [`floor_char_boundary`]: str::floor_char_boundary
///
/// [`is_char_boundary(x)`]: Self::is_char_boundary
///
/// # Examples
///
@ -2192,7 +2194,7 @@ pub fn trim_start_matches<P: Pattern>(&self, pat: P) -> &str {
/// Returns a string slice with the prefix removed.
///
/// If the string starts with the pattern `prefix`, returns the substring after the prefix,
/// wrapped in `Some`. Unlike `trim_start_matches`, this method removes the prefix exactly once.
/// wrapped in `Some`. Unlike [`trim_start_matches`], this method removes the prefix exactly once.
///
/// If the string does not start with `prefix`, returns `None`.
///
@ -2201,6 +2203,7 @@ pub fn trim_start_matches<P: Pattern>(&self, pat: P) -> &str {
///
/// [`char`]: prim@char
/// [pattern]: self::pattern
/// [`trim_start_matches`]: Self::trim_start_matches
///
/// # Examples
///
@ -2219,7 +2222,7 @@ pub fn strip_prefix<P: Pattern>(&self, prefix: P) -> Option<&str> {
/// Returns a string slice with the suffix removed.
///
/// If the string ends with the pattern `suffix`, returns the substring before the suffix,
/// wrapped in `Some`. Unlike `trim_end_matches`, this method removes the suffix exactly once.
/// wrapped in `Some`. Unlike [`trim_end_matches`], this method removes the suffix exactly once.
///
/// If the string does not end with `suffix`, returns `None`.
///
@ -2228,6 +2231,7 @@ pub fn strip_prefix<P: Pattern>(&self, prefix: P) -> Option<&str> {
///
/// [`char`]: prim@char
/// [pattern]: self::pattern
/// [`trim_end_matches`]: Self::trim_end_matches
///
/// # Examples
///