bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

libcore: clarify documentation for char_at(_reverse)

Browse source
This commit is contained in:
Huon Wilson 2013-04-19 22:30:49 +10:00
parent d3a58f3797
commit 8ae6b33ed0
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/libcore/str.rs
View file

@ -1863,7 +1863,7 @@ pub fn char_range_at(s: &str, i: uint) -> CharRange {
return CharRange {ch: val as char, next: i};
}
/// Plucks the `n`th character from the beginning of a string
/// Plucks the character starting at the `i`th byte of a string
pub fn char_at(s: &str, i: uint) -> char {
return char_range_at(s, i).ch;
}
@ -1874,11 +1874,11 @@ pub struct CharRange {
}
/**
* Given a byte position and a str, return the previous char and its position
* Given a byte position and a str, return the previous char and its position.
*
* This function can be used to iterate over a unicode string in reverse.
*
* returns 0 for next index if called on start index 0
* Returns 0 for next index if called on start index 0.
*/
pub fn char_range_at_reverse(ss: &str, start: uint) -> CharRange {
let mut prev = start;
@ -1900,7 +1900,7 @@ pub fn char_range_at_reverse(ss: &str, start: uint) -> CharRange {
return CharRange {ch:ch, next:prev};
}
/// Plucks the `n`th character from the end of a string
/// Plucks the character ending at the `i`th byte of a string
pub fn char_at_reverse(s: &str, i: uint) -> char {
char_range_at_reverse(s, i).ch
}