String::truncate doc: also fails if not a char boundary

This commit is contained in:
Simon Sapin 2014-10-05 12:15:59 +01:00
parent dfbe9eb3b2
commit 80401da12e

View File

@ -613,7 +613,8 @@ impl String {
///
/// # Failure
///
/// Fails if `len` > current length.
/// Fails if `new_len` > current length,
/// or if `new_len` is not a character boundary.
///
/// # Example
///
@ -624,9 +625,9 @@ impl String {
/// ```
#[inline]
#[unstable = "the failure conventions for strings are under development"]
pub fn truncate(&mut self, len: uint) {
assert!(self.as_slice().is_char_boundary(len));
self.vec.truncate(len)
pub fn truncate(&mut self, new_len: uint) {
assert!(self.as_slice().is_char_boundary(new_len));
self.vec.truncate(new_len)
}
/// Appends a byte to this string buffer.