Struct std::string::StringStable [-]  [+] [src]

pub struct String {
    // some fields omitted
}

A growable string stored as a UTF-8 encoded buffer.

Methods

impl String

fn new() -> String

Creates a new string buffer initialized with the empty string.

Example

fn main() { let mut s = String::new(); }
let mut s = String::new();

fn with_capacity(capacity: uint) -> String

Creates a new string buffer with the given capacity. The string will be able to hold exactly capacity bytes without reallocating. If capacity is 0, the string will not allocate.

Example

fn main() { let mut s = String::with_capacity(10); }
let mut s = String::with_capacity(10);

fn from_str(string: &str) -> String

Creates a new string buffer from the given string.

Example

fn main() { let s = String::from_str("hello"); assert_eq!(s.as_slice(), "hello"); }
let s = String::from_str("hello");
assert_eq!(s.as_slice(), "hello");

fn from_utf8(vec: Vec<u8>) -> Result<String, Vec<u8>>

Returns the vector as a string buffer, if possible, taking care not to copy it.

Returns Err with the original vector if the vector contains invalid UTF-8.

Example

fn main() { let hello_vec = vec![104, 101, 108, 108, 111]; let s = String::from_utf8(hello_vec); assert_eq!(s, Ok("hello".to_string())); let invalid_vec = vec![240, 144, 128]; let s = String::from_utf8(invalid_vec); assert_eq!(s, Err(vec![240, 144, 128])); }
let hello_vec = vec![104, 101, 108, 108, 111];
let s = String::from_utf8(hello_vec);
assert_eq!(s, Ok("hello".to_string()));

let invalid_vec = vec![240, 144, 128];
let s = String::from_utf8(invalid_vec);
assert_eq!(s, Err(vec![240, 144, 128]));

fn from_utf8_lossy(v: &'a [u8]) -> MaybeOwned<'a>

Converts a vector of bytes to a new UTF-8 string. Any invalid UTF-8 sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Example

fn main() { let input = b"Hello \xF0\x90\x80World"; let output = String::from_utf8_lossy(input); assert_eq!(output.as_slice(), "Hello \uFFFDWorld"); }
let input = b"Hello \xF0\x90\x80World";
let output = String::from_utf8_lossy(input);
assert_eq!(output.as_slice(), "Hello \uFFFDWorld");

fn from_utf16(v: &[u16]) -> Option<String>

Decode a UTF-16 encoded vector v into a String, returning None if v contains any invalid data.

Example

fn main() { // 𝄞music let mut v = &mut [0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063]; assert_eq!(String::from_utf16(v), Some("𝄞music".to_string())); // 𝄞mu<invalid>ic v[4] = 0xD800; assert_eq!(String::from_utf16(v), None); }
// 𝄞music
let mut v = &mut [0xD834, 0xDD1E, 0x006d, 0x0075,
                  0x0073, 0x0069, 0x0063];
assert_eq!(String::from_utf16(v), Some("𝄞music".to_string()));

// 𝄞mu<invalid>ic
v[4] = 0xD800;
assert_eq!(String::from_utf16(v), None);

fn from_utf16_lossy(v: &[u16]) -> String

Decode a UTF-16 encoded vector v into a string, replacing invalid data with the replacement character (U+FFFD).

Example

fn main() { // 𝄞mus<invalid>ic<invalid> let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0xDD1E, 0x0069, 0x0063, 0xD834]; assert_eq!(String::from_utf16_lossy(v), "𝄞mus\uFFFDic\uFFFD".to_string()); }
// 𝄞mus<invalid>ic<invalid>
let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
          0x0073, 0xDD1E, 0x0069, 0x0063,
          0xD834];

assert_eq!(String::from_utf16_lossy(v),
           "𝄞mus\uFFFDic\uFFFD".to_string());

fn from_chars(chs: &[char]) -> String

Convert a vector of chars to a String.

Example

fn main() { let chars = &['h', 'e', 'l', 'l', 'o']; let s = String::from_chars(chars); assert_eq!(s.as_slice(), "hello"); }
let chars = &['h', 'e', 'l', 'l', 'o'];
let s = String::from_chars(chars);
assert_eq!(s.as_slice(), "hello");

fn into_bytes(self) -> Vec<u8>

Return the underlying byte buffer, encoded as UTF-8.

Example

fn main() { let s = String::from_str("hello"); let bytes = s.into_bytes(); assert_eq!(bytes, vec![104, 101, 108, 108, 111]); }
let s = String::from_str("hello");
let bytes = s.into_bytes();
assert_eq!(bytes, vec![104, 101, 108, 108, 111]);

fn from_char(length: uint, ch: char) -> String

Creates a string buffer by repeating a character length times.

Example

fn main() { let s = String::from_char(5, 'a'); assert_eq!(s.as_slice(), "aaaaa"); }
let s = String::from_char(5, 'a');
assert_eq!(s.as_slice(), "aaaaa");

fn push_str(&mut self, string: &str)

Pushes the given string onto this string buffer.

Example

fn main() { let mut s = String::from_str("foo"); s.push_str("bar"); assert_eq!(s.as_slice(), "foobar"); }
let mut s = String::from_str("foo");
s.push_str("bar");
assert_eq!(s.as_slice(), "foobar");

fn grow(&mut self, count: uint, ch: char)

Pushes ch onto the given string count times.

Example

fn main() { let mut s = String::from_str("foo"); s.grow(5, 'Z'); assert_eq!(s.as_slice(), "fooZZZZZ"); }
let mut s = String::from_str("foo");
s.grow(5, 'Z');
assert_eq!(s.as_slice(), "fooZZZZZ");

fn capacity(&self) -> uint

Returns the number of bytes that this string buffer can hold without reallocating.

Example

fn main() { let s = String::with_capacity(10); assert!(s.capacity() >= 10); }
let s = String::with_capacity(10);
assert!(s.capacity() >= 10);

fn reserve_additional(&mut self, extra: uint)

Deprecated: Renamed to reserve.

fn reserve(&mut self, additional: uint)

Reserves capacity for at least additional more bytes to be inserted in the given String. The collection may reserve more space to avoid frequent reallocations.

Panics

Panics if the new capacity overflows uint.

Example

fn main() { let mut s = String::new(); s.reserve(10); assert!(s.capacity() >= 10); }
let mut s = String::new();
s.reserve(10);
assert!(s.capacity() >= 10);

fn reserve_exact(&mut self, additional: uint)

Reserves the minimum capacity for exactly additional more bytes to be inserted in the given String. Does nothing if the capacity is already sufficient.

Note that the allocator may give the collection more space than it requests. Therefore capacity can not be relied upon to be precisely minimal. Prefer reserve if future insertions are expected.

Panics

Panics if the new capacity overflows uint.

Example

fn main() { let mut s = String::new(); s.reserve(10); assert!(s.capacity() >= 10); }
let mut s = String::new();
s.reserve(10);
assert!(s.capacity() >= 10);

fn shrink_to_fit(&mut self)

Shrinks the capacity of this string buffer to match its length.

Example

fn main() { let mut s = String::from_str("foo"); s.reserve(100); assert!(s.capacity() >= 100); s.shrink_to_fit(); assert_eq!(s.capacity(), 3); }
let mut s = String::from_str("foo");
s.reserve(100);
assert!(s.capacity() >= 100);
s.shrink_to_fit();
assert_eq!(s.capacity(), 3);

fn push(&mut self, ch: char)

Adds the given character to the end of the string.

Example

fn main() { let mut s = String::from_str("abc"); s.push('1'); s.push('2'); s.push('3'); assert_eq!(s.as_slice(), "abc123"); }
let mut s = String::from_str("abc");
s.push('1');
s.push('2');
s.push('3');
assert_eq!(s.as_slice(), "abc123");

fn as_bytes(&'a self) -> &'a [u8]

Works with the underlying buffer as a byte slice.

Example

fn main() { let s = String::from_str("hello"); let b: &[_] = &[104, 101, 108, 108, 111]; assert_eq!(s.as_bytes(), b); }
let s = String::from_str("hello");
let b: &[_] = &[104, 101, 108, 108, 111];
assert_eq!(s.as_bytes(), b);

fn truncate(&mut self, new_len: uint)

Shortens a string to the specified length.

Panics

Panics if new_len > current length, or if new_len is not a character boundary.

Example

fn main() { let mut s = String::from_str("hello"); s.truncate(2); assert_eq!(s.as_slice(), "he"); }
let mut s = String::from_str("hello");
s.truncate(2);
assert_eq!(s.as_slice(), "he");

fn pop(&mut self) -> Option<char>

Removes the last character from the string buffer and returns it. Returns None if this string buffer is empty.

Example

fn main() { let mut s = String::from_str("foo"); assert_eq!(s.pop(), Some('o')); assert_eq!(s.pop(), Some('o')); assert_eq!(s.pop(), Some('f')); assert_eq!(s.pop(), None); }
let mut s = String::from_str("foo");
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('f'));
assert_eq!(s.pop(), None);

fn remove(&mut self, idx: uint) -> Option<char>

Removes the character from the string buffer at byte position idx and returns it. Returns None if idx is out of bounds.

Warning

This is an O(n) operation as it requires copying every element in the buffer.

Panics

If idx does not lie on a character boundary, then this function will panic.

Example

fn main() { let mut s = String::from_str("foo"); assert_eq!(s.remove(0), Some('f')); assert_eq!(s.remove(1), Some('o')); assert_eq!(s.remove(0), Some('o')); assert_eq!(s.remove(0), None); }
let mut s = String::from_str("foo");
assert_eq!(s.remove(0), Some('f'));
assert_eq!(s.remove(1), Some('o'));
assert_eq!(s.remove(0), Some('o'));
assert_eq!(s.remove(0), None);

fn insert(&mut self, idx: uint, ch: char)

Insert a character into the string buffer at byte position idx.

Warning

This is an O(n) operation as it requires copying every element in the buffer.

Panics

If idx does not lie on a character boundary or is out of bounds, then this function will panic.

unsafe fn as_mut_vec(&'a mut self) -> &'a mut Vec<u8>

Views the string buffer as a mutable sequence of bytes.

This is unsafe because it does not check to ensure that the resulting string will be valid UTF-8.

Example

fn main() { let mut s = String::from_str("hello"); unsafe { let vec = s.as_mut_vec(); assert!(vec == &mut vec![104, 101, 108, 108, 111]); vec.reverse(); } assert_eq!(s.as_slice(), "olleh"); }
let mut s = String::from_str("hello");
unsafe {
    let vec = s.as_mut_vec();
    assert!(vec == &mut vec![104, 101, 108, 108, 111]);
    vec.reverse();
}
assert_eq!(s.as_slice(), "olleh");

fn len(&self) -> uint

Return the number of bytes in this string.

Example

fn main() { let a = "foo".to_string(); assert_eq!(a.len(), 3); }
let a = "foo".to_string();
assert_eq!(a.len(), 3);

fn is_empty(&self) -> bool

Returns true if the string contains no bytes

Example

fn main() { let mut v = String::new(); assert!(v.is_empty()); v.push('a'); assert!(!v.is_empty()); }
let mut v = String::new();
assert!(v.is_empty());
v.push('a');
assert!(!v.is_empty());

fn clear(&mut self)

Truncates the string, returning it to 0 length.

Example

fn main() { let mut s = "foo".to_string(); s.clear(); assert!(s.is_empty()); }
let mut s = "foo".to_string();
s.clear();
assert!(s.is_empty());

Trait Implementations

impl OwnedAsciiCast for String

fn is_ascii(&self) -> bool

unsafe fn into_ascii_nocheck(self) -> Vec<Ascii>

fn into_ascii(self) -> Vec<Ascii>

fn into_ascii_opt(self) -> Option<Vec<Ascii>>

impl OwnedAsciiExt for String

fn into_ascii_upper(self) -> String

fn into_ascii_lower(self) -> String

impl<'a> IntoMaybeOwned<'a> for String

fn into_maybe_owned(self) -> MaybeOwned<'a>

Example

fn main() { let owned_string = String::from_str("orange"); let maybe_owned_string = owned_string.into_maybe_owned(); assert_eq!(true, maybe_owned_string.is_owned()); }
let owned_string = String::from_str("orange");
let maybe_owned_string = owned_string.into_maybe_owned();
assert_eq!(true, maybe_owned_string.is_owned());

impl FromIterator<char> for String

fn from_iter<I: Iterator<char>>(iterator: I) -> String

impl Extend<char> for String

fn extend<I: Iterator<char>>(&mut self, iterator: I)

impl Str for String

fn as_slice(&'a self) -> &'a str

impl StrAllocating for String

fn into_string(self) -> String

fn escape_default(&self) -> String

fn escape_unicode(&self) -> String

fn replace(&self, &str, &str) -> String

fn repeat(&self, uint) -> String

fn lev_distance(&self, &str) -> uint

fn nfd_chars(&'a self) -> Decompositions<'a>

fn nfkd_chars(&'a self) -> Decompositions<'a>

fn nfc_chars(&'a self) -> Recompositions<'a>

fn nfkc_chars(&'a self) -> Recompositions<'a>

impl Default for String

fn default() -> String

impl Show for String

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

impl<H: Writer> Hash<H> for String

fn hash(&self, hasher: &mut H)

impl<'a, S: Str> Equiv<S> for String

fn equiv(&self, other: &S) -> bool

impl<S: Str> Add<S, String> for String

fn add(&self, other: &S) -> String

impl Slice<uint, str> for String

fn as_slice_(&'a self) -> &'a str

fn slice_from_or_fail(&'a self, from: &uint) -> &'a str

fn slice_to_or_fail(&'a self, to: &uint) -> &'a str

fn slice_or_fail(&'a self, from: &uint, to: &uint) -> &'a str

impl Deref<str> for String

fn deref(&'a self) -> &'a str

impl FromStr for String

fn from_str(s: &str) -> Option<String>

impl BytesContainer for String

fn container_as_bytes(&self) -> &[u8]

fn container_as_str(&self) -> Option<&str>

fn is_str(_: Option<&String>) -> bool

impl ToCStr for String

fn to_c_str(&self) -> CString

unsafe fn to_c_str_unchecked(&self) -> CString

fn with_c_str<T>(&self, f: |*const i8| -> T) -> T

unsafe fn with_c_str_unchecked<T>(&self, f: |*const i8| -> T) -> T

fn with_c_str<T>(&self, |*const i8| -> T) -> T

unsafe fn with_c_str_unchecked<T>(&self, |*const i8| -> T) -> T

Derived Implementations

impl Ord for String

fn cmp(&self, __arg_0: &String) -> Ordering

impl Eq for String

fn assert_receiver_is_total_eq(&self)

impl PartialOrd for String

fn partial_cmp(&self, __arg_0: &String) -> Option<Ordering>

fn lt(&self, __arg_0: &String) -> bool

fn le(&self, __arg_0: &String) -> bool

fn gt(&self, __arg_0: &String) -> bool

fn ge(&self, __arg_0: &String) -> bool

fn lt(&self, &String) -> bool

fn le(&self, &String) -> bool

fn gt(&self, &String) -> bool

fn ge(&self, &String) -> bool

impl PartialEq for String

fn eq(&self, __arg_0: &String) -> bool

fn ne(&self, __arg_0: &String) -> bool

fn ne(&self, &String) -> bool

impl Clone for String

fn clone(&self) -> String

fn clone_from(&mut self, &String)