Struct CharString 

pub struct CharString(/* private fields */);

Compact, clone-on-write, UTF-8 encoded, growable string type.

Heap allocations store a capacity and are always growable. Use CharString::freeze to convert to the capacity-less heap representation used by CharStr.

Implementations

impl CharString

pub const fn new() -> Self

Creates a new empty CharString.

Same as String::new(), this will not allocate on the heap.

Examples

let s = CharString::new();
assert!(s.is_empty());
assert!(!s.is_heap_allocated());

pub fn freeze(self) -> CharStr

Converts this value into an immutable, exactly allocated CharStr.

Unique growable heap storage is converted to exact storage with realloc. Shared heap storage is copied into a new exact allocation.

Panics

Panics if converting heap storage fails. To handle allocation failure, use CharString::try_freeze().

pub fn try_freeze(self) -> Result<CharStr, ReserveError>

Tries to convert this value into an immutable, exactly allocated CharStr.

Inline and static storage are transferred without reallocating. Unique growable heap storage is converted with realloc, while shared heap storage is copied.

Errors

Returns a ReserveError if converting heap storage fails. Because this method consumes self, the original CharString is dropped on failure.

pub const fn from_static_str(text: &'static str) -> Self

Creates a new CharString from a &'static str.

Panics

Panics if text is longer than 2^56 - 1 bytes on a 64-bit architecture or 2^24 - 1 (16_777_215) bytes on a 32-bit architecture.

Examples

let s = CharString::from_static_str("Long text but static lifetime");
assert_eq!(s.as_str(), "Long text but static lifetime");
assert_eq!(s.len(), 29);
assert!(!s.is_heap_allocated());

pub fn with_capacity(capacity: usize) -> Self

Creates a new empty CharString with at least capacity bytes.

A CharString will inline strings if the length is less than or equal to 2 * size_of::<usize>() bytes. This means that the minimum capacity of a CharString is 2 * size_of::<usize>() bytes.

Panics

Panics if any of the following conditions is met:

• The system is out-of-memory.
• On 64-bit architecture, the capacity is greater than 2^56 - 1.
• On 32-bit architecture, the capacity is greater than 2^31 - 16 (2_147_483_632).

If you want to handle such a problem manually, use CharString::try_with_capacity().

Examples

inline capacity

let s = CharString::with_capacity(4);
assert_eq!(s.capacity(), 2 * size_of::<usize>());
assert!(!s.is_heap_allocated());

heap capacity

let s = CharString::with_capacity(100);
assert_eq!(s.capacity(), 100);
assert!(s.is_heap_allocated());

pub fn try_with_capacity(capacity: usize) -> Result<Self, ReserveError>

Fallible version of CharString::with_capacity().

This method won’t panic if the system is out of memory, or if the capacity is too large, but returns a ReserveError. Otherwise it behaves the same as CharString::with_capacity().

pub fn from_utf8(buf: &[u8]) -> Result<Self, Utf8Error>

Converts a slice of bytes to a CharString.

If the slice is not valid UTF-8, an error is returned.

Examples

valid UTF-8

let bytes = vec![240, 159, 166, 128];
let string = CharString::from_utf8(&bytes).expect("valid UTF-8");

assert_eq!(string, "🦀");

invalid UTF-8

let bytes = &[255, 255, 255];
let result = CharString::from_utf8(bytes);

assert!(result.is_err());

pub fn from_utf8_lossy(buf: &[u8]) -> Self

Converts a slice of bytes to a CharString, including invalid characters.

During this conversion, all invalid characters are replaced with the char::REPLACEMENT_CHARACTER.

Examples

let invalid_bytes = b"Hello \xF0\x90\x80World";
let string = CharString::from_utf8_lossy(invalid_bytes);

assert_eq!(string, "Hello �World");

pub unsafe fn from_utf8_unchecked(buf: &[u8]) -> Self

Converts a slice of bytes to a CharString without checking if the bytes are valid UTF-8.

Safety

This function is unsafe because it does not check that the bytes passed to it are valid UTF-8. If this constraint is violated, it may cause memory unsafety issues.

pub fn from_utf16(buf: &[u16]) -> Result<Self, FromUtf16Error>

Decodes a slice of UTF-16 encoded bytes to a CharString, returning an error if buf contains any invalid code points.

Examples

valid UTF-16

let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
assert_eq!(CharString::from_utf16(v).unwrap(), "𝄞music");

invalid UTF-16

// 𝄞mu<invalid>ic
let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063];
assert!(CharString::from_utf16(v).is_err());

pub fn from_utf16_lossy(buf: &[u16]) -> Self

Decodes a slice of UTF-16 encoded bytes to a CharString, replacing invalid code points with the char::REPLACEMENT_CHARACTER.

Examples

// 𝄞mus<invalid>ic<invalid>
let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0xDD1E, 0x0069, 0x0063, 0xD834];
assert_eq!(CharString::from_utf16_lossy(v), "𝄞mus\u{FFFD}ic\u{FFFD}");

pub const fn len(&self) -> usize

Returns the length of the string in bytes, not char or graphemes.

Examples

let a = CharString::from("foo");
assert_eq!(a.len(), 3);

let fancy_f = CharString::from("ƒoo");
assert_eq!(fancy_f.len(), 4);
assert_eq!(fancy_f.chars().count(), 3);

pub const fn is_empty(&self) -> bool

Returns true if the CharString has a length of 0, false otherwise

Examples

let mut s = CharString::new();
assert!(s.is_empty());

s.push('a');
assert!(!s.is_empty());

pub fn capacity(&self) -> usize

Returns the capacity of the CharString, in bytes.

Inline values have a capacity of 2 * size_of::<usize>() bytes. Heap values return their stored growable capacity. A heap-allocated CharStr remains heap-allocated when converted to growable storage, so the resulting capacity can be smaller than the inline capacity.

Examples

inline capacity

let s = CharString::new();
assert_eq!(s.capacity(), 2 * size_of::<usize>());

heap capacity

let s = CharString::with_capacity(100);
assert_eq!(s.capacity(), 100);

pub const fn as_str(&self) -> &str

Returns a string slice containing the entire CharString.

Examples

let s = CharString::from("foo");
assert_eq!(s.as_str(), "foo");

pub const fn as_bytes(&self) -> &[u8]

Returns a byte slice containing the entire CharString.

Examples

let s = CharString::from("hello");
assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional bytes more than the current length.

Note

This method clones the CharString if it is not unique.

Panics

Panics if any of the following conditions is met:

• The system is out-of-memory.
• On 64-bit architecture, the capacity is greater than 2^56 - 1.
• On 32-bit architecture, the capacity is greater than 2^31 - 16 (2_147_483_632).

If you want to handle such a problem manually, use CharString::try_reserve().

Examples

let mut s = CharString::new();

// We have an inline storage on the stack.
assert_eq!(s.capacity(), 2 * size_of::<usize>());
assert!(!s.is_heap_allocated());

s.reserve(100);

// Now we have a heap storage.
assert!(s.capacity() >= s.len() + 100);
assert!(s.is_heap_allocated());

pub fn try_reserve(&mut self, additional: usize) -> Result<(), ReserveError>

Fallible version of CharString::reserve().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::reserve().

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the CharString to match its length.

The resulting capacity is always greater than 2 * size_of::<usize>() bytes because CharString has inline (on the stack) storage.

Note

This method clones the CharString if it is not unique and its capacity is greater than its length.

Panics

Panics if cloning the CharString fails due to the system being out-of-memory. If you want to handle such a problem manually, use CharString::try_shrink_to_fit().

Examples

short string

let mut s = CharString::from("foo");

s.reserve(100);
assert_eq!(s.capacity(), 3 + 100);

s.shrink_to_fit();
assert_eq!(s.capacity(), 2 * size_of::<usize>());

long string

let mut s = CharString::from("This is a text the length is more than 16 bytes");

s.reserve(100);
assert!(s.capacity() > 16 + 100);

s.shrink_to_fit();
assert_eq!(s.capacity(), s.len());

pub fn try_shrink_to_fit(&mut self) -> Result<(), ReserveError>

Fallible version of CharString::shrink_to_fit().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::shrink_to_fit().

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity of the CharString with a lower bound.

The resulting capacity is always greater than 2 * size_of::<usize>() bytes because the CharString has inline (on the stack) storage.

Note

This method clones the CharString if it is not unique and its capacity will be changed.

Panics

Panics if cloning the CharString fails due to the system being out-of-memory. If you want to handle such a problem manually, use CharString::try_shrink_to().

Examples

let mut s = CharString::with_capacity(100);
assert_eq!(s.capacity(), 100);

// if the capacity was already bigger than the argument and unique, the call is no-op.
s.shrink_to(100);
assert_eq!(s.capacity(), 100);

s.shrink_to(50);
assert_eq!(s.capacity(), 50);

// if the string can be inlined, it is
s.shrink_to(5);
assert_eq!(s.capacity(), 2 * size_of::<usize>());

pub fn try_shrink_to(&mut self, min_capacity: usize) -> Result<(), ReserveError>

Fallible version of CharString::shrink_to().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::shrink_to().

pub fn push(&mut self, ch: char)

Appends the given char to the end of the CharString.

Panics

Panics if the system is out-of-memory. If you want to handle such a problem manually, use CharString::try_push().

Examples

let mut s = CharString::new();
s.push('f');
s.push('o');
s.push('o');
assert_eq!("foo", s);

pub fn try_push(&mut self, ch: char) -> Result<(), ReserveError>

Fallible version of CharString::push().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::push().

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

Removes the last character from the CharString and returns it. If the CharString is empty, None is returned.

Panics

On 32-bit architectures, this method needs to clone the CharString under both of the following conditions, and may panic if that allocation fails:

• The CharString is not unique.
• Its length is greater than 2^24 - 2.

If you want to handle such a problem manually, use CharString::try_pop().

Examples

let mut s = CharString::from("abč");

assert_eq!(s.pop(), Some('č'));
assert_eq!(s.pop(), Some('b'));
assert_eq!(s.pop(), Some('a'));

assert_eq!(s.pop(), None);

pub fn try_pop(&mut self) -> Result<Option<char>, ReserveError>

Fallible version of CharString::pop().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::pop().

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

Appends a given string slice onto the end of this CharString.

Panics

Panics if cloning the CharString fails due to the system being out-of-memory. If you want to handle such a problem manually, use CharString::try_push_str().

Examples

let mut s = CharString::from("foo");

s.push_str("bar");

assert_eq!("foobar", s);

pub fn try_push_str(&mut self, string: &str) -> Result<(), ReserveError>

Fallible version of CharString::push_str().

This method won’t panic if the system is out-of-memory, or the capacity is too large, but return an ReserveError. Otherwise it behaves the same as CharString::push_str().

pub fn remove(&mut self, idx: usize) -> char

Removes a char from the CharString at a byte position and returns it.

Panics

Panics if any of the following conditions:

1. idx is larger than or equal tothe CharString’s length, or if it does not lie on a char
2. The system is out-of-memory when cloning the CharString.

For 2, if you want to handle such a problem manually, use CharString::try_remove().

Examples

let mut s = CharString::from("Hello 世界");

assert_eq!(s.remove(6), '世');
assert_eq!(s.remove(1), 'e');

assert_eq!(s, "Hllo 界");

Past total length:

let mut c = CharString::from("hello there!");
c.remove(12);

Not on char boundary:

let mut c = CharString::from("🦄");
c.remove(1);

pub fn try_remove(&mut self, idx: usize) -> Result<char, ReserveError>

Fallible version of CharString::remove().

This method won’t panic if the system is out-of-memory, but return an ReserveError. Otherwise it behaves the same as CharString::remove().

Panics

This method still panics if the idx is larger than or equal to the CharString’s length, or if it does not lie on a char boundary.

pub fn retain(&mut self, predicate: impl FnMut(char) -> bool)

Retains only the characters specified by the predicate.

If the predicate returns true, the character is kept, otherwise it is removed.

Panics

Panics if the system is out-of-memory when cloning the CharString. If you want to handle such a problem manually, use CharString::try_retain().

Examples

let mut s = CharString::from("äb𝄞d€");

let keep = [false, true, true, false, true];
let mut iter = keep.iter();
s.retain(|_| *iter.next().unwrap());

assert_eq!(s, "b𝄞€");

pub fn try_retain( &mut self, predicate: impl FnMut(char) -> bool, ) -> Result<(), ReserveError>

Fallible version of CharString::retain().

This method won’t panic if the system is out-of-memory, but return an ReserveError.

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

Inserts a character into the CharString at a byte position.

Panics

Panics if any of the following conditions:

1. idx is larger than the CharString’s length, or if it does not lie on a char boundary.
2. The system is out-of-memory when cloning the CharString.
3. The resulting length is greater than 2^56 - 1 on a 64-bit architecture or 2^31 - 16 (2_147_483_632) on a 32-bit architecture.

For 2 and 3, if you want to handle such a problem manually, use CharString::try_insert().

Examples

let mut s = CharString::from("Hello world");

s.insert(11, '!');
assert_eq!("Hello world!", s);

s.insert(5, ',');
assert_eq!("Hello, world!", s);

pub fn try_insert(&mut self, idx: usize, ch: char) -> Result<(), ReserveError>

Fallible version of CharString::insert().

This method won’t panic if the system is out-of-memory, or the capacity becomes too large by inserting a character, but return an ReserveError. Otherwise it behaves the same as CharString::insert().

Panics

This method still panics if the idx is larger than the CharString’s length, or if it does not lie on a char boundary.

pub fn insert_str(&mut self, idx: usize, string: &str)

Inserts a string slice into the CharString at a byte position.

Panics

Panics if any of the following conditions:

1. idx is larger than the CharString’s length, or if it does not lie on a char boundary.
2. The system is out-of-memory when cloning the CharString.
3. The resulting length is greater than 2^56 - 1 on a 64-bit architecture or 2^31 - 16 (2_147_483_632) on a 32-bit architecture.

For 2 and 3, if you want to handle such a problem manually, use CharString::try_insert_str().

Examples

let mut s = CharString::from("bar");
s.insert_str(0, "foo");
assert_eq!("foobar", s);

pub fn try_insert_str( &mut self, idx: usize, string: &str, ) -> Result<(), ReserveError>

Fallible version of CharString::insert_str().

This method won’t panic if the system is out-of-memory, or the capacity becomes too large by inserting a string slice, but return an ReserveError. Otherwise it behaves the same as CharString::insert_str().

Panics

This method still panics if the idx is larger than the CharString’s length, or if it does not lie on a char boundary.

pub fn repeat(&self, n: usize) -> Self

Creates a new CharString by repeating self n times.

Panics

Panics if any of the following conditions is met:

1. The resulting capacity would overflow (self.len() * n exceeds usize::MAX).
2. The system is out-of-memory.
3. The resulting length is greater than 2^56 - 1 on a 64-bit architecture or 2^31 - 16 (2_147_483_632) on a 32-bit architecture.

If you want to handle such a problem manually, use CharString::try_repeat().

Examples

let s = CharString::from("abc");
assert_eq!(s.repeat(4), "abcabcabcabc");
assert_eq!(s.repeat(0), "");

pub fn try_repeat(&self, n: usize) -> Result<Self, ReserveError>

Fallible version of CharString::repeat().

This method won’t panic, but returns a ReserveError if the capacity would overflow, the system is out-of-memory, or the resulting length exceeds the maximum. Otherwise it behaves the same as CharString::repeat().

pub fn truncate(&mut self, new_len: usize)

Shortens a CharString to the specified length.

If new_len is greater than or equal to the string’s current length, this has no effect.

Panics

Panics if any of the following conditions is met:

1. new_len does not lie on a char boundary.
2. The system is out-of-memory when cloning the CharString.

For 2, If you want to handle such a problem manually, use CharString::try_truncate().

Examples

let mut s = CharString::from("hello");
s.truncate(2);
assert_eq!(s, "he");

// Truncating to a larger length does nothing:
s.truncate(10);
assert_eq!(s, "he");

pub fn try_truncate(&mut self, new_len: usize) -> Result<(), ReserveError>

Fallible version of CharString::truncate().

This method won’t panic if the system is out-of-memory, but return an ReserveError. Otherwise it behaves the same as CharString::truncate().

Panics

This method still panics if new_len does not lie on a char boundary.

pub fn split_off(&mut self, at: usize) -> Self

Splits the string into two at the given byte index.

Returns a newly allocated CharString. self contains bytes [0, at), and the returned CharString contains bytes [at, len). at must be on the boundary of a UTF-8 code point.

Panics

Panics if any of the following conditions is met:

1. at does not lie on a char boundary, or is beyond the end of the string.
2. The system is out-of-memory when creating the new CharString.

For 2, if you want to handle such a problem manually, use CharString::try_split_off().

Examples

let mut hello = CharString::from("Hello, World!");
let world = hello.split_off(7);
assert_eq!(hello, "Hello, ");
assert_eq!(world, "World!");

pub fn try_split_off(&mut self, at: usize) -> Result<Self, ReserveError>

Fallible version of CharString::split_off().

This method won’t panic if the system is out-of-memory, but returns a ReserveError. Otherwise it behaves the same as CharString::split_off().

Panics

This method still panics if at does not lie on a char boundary, or is beyond the end of the string.

pub fn clear(&mut self)

Reduces the length of the CharString to zero without allocating.

If the CharString has a unique growable buffer, this method will not change the capacity. Shared heap buffers are released, leaving an empty inline CharString.

Examples

unique growable buffer

let mut s = CharString::from("This is a example of unique CharString");
assert_eq!(s.capacity(), 38);

s.clear();

assert_eq!(s, "");
assert_eq!(s.capacity(), 38);

shared growable buffer

let mut s = CharString::from("This is a example of not unique CharString");
assert_eq!(s.capacity(), 42);

let s2 = s.clone();
s.clear();

assert_eq!(s, "");
assert_eq!(s.capacity(), 2 * size_of::<usize>());

pub fn is_heap_allocated(&self) -> bool

Returns whether the CharString is heap-allocated.

Examples

inline

let s = CharString::from("hello");
assert!(!s.is_heap_allocated());

heap

let s = CharString::from("More than 2 * size_of::<usize>() bytes is heap-allocated");
assert!(s.is_heap_allocated());

Methods from Deref<Target = str>

pub fn len(&self) -> usize

Returns the length of self.

This length is in bytes, not chars or graphemes. In other words, it might not be what a human considers the length of the string.

Examples

let len = "foo".len();
assert_eq!(3, len);

assert_eq!("ƒoo".len(), 4); // fancy f!
assert_eq!("ƒoo".chars().count(), 3);

pub fn is_empty(&self) -> bool

Returns true if self has a length of zero bytes.

Examples

let s = "";
assert!(s.is_empty());

let s = "not empty";
assert!(!s.is_empty());

pub fn is_char_boundary(&self, index: usize) -> bool

Checks that index-th byte is the first byte in a UTF-8 code point sequence or the end of the string.

The start and end of the string (when index == self.len()) are considered to be boundaries.

Returns false if index is greater than self.len().

Examples

let s = "Löwe 老虎 Léopard";
assert!(s.is_char_boundary(0));
// start of `老`
assert!(s.is_char_boundary(6));
assert!(s.is_char_boundary(s.len()));

// second byte of `ö`
assert!(!s.is_char_boundary(2));

// third byte of `老`
assert!(!s.is_char_boundary(8));

pub fn floor_char_boundary(&self, index: usize) -> usize

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 and can still visually split graphemes, even though the underlying characters aren’t split. For example, the emoji 🧑‍🔬 (scientist) could be split so that the string only includes 🧑 (person) instead.

Examples

let s = "❤️🧡💛💚💙💜";
assert_eq!(s.len(), 26);
assert!(!s.is_char_boundary(13));

let closest = s.floor_char_boundary(13);
assert_eq!(closest, 10);
assert_eq!(&s[..closest], "❤️🧡");

pub fn ceil_char_boundary(&self, index: usize) -> usize

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.

This method is the natural complement to floor_char_boundary. See that method for more details.

Examples

let s = "❤️🧡💛💚💙💜";
assert_eq!(s.len(), 26);
assert!(!s.is_char_boundary(13));

let closest = s.ceil_char_boundary(13);
assert_eq!(closest, 14);
assert_eq!(&s[..closest], "❤️🧡💛");

pub fn as_bytes(&self) -> &[u8]

Converts a string slice to a byte slice. To convert the byte slice back into a string slice, use the from_utf8 function.

Examples

let bytes = "bors".as_bytes();
assert_eq!(b"bors", bytes);

pub fn as_ptr(&self) -> *const u8

Converts a string slice to a raw pointer.

As string slices are a slice of bytes, the raw pointer points to a u8. This pointer will be pointing to the first byte of the string slice.

The caller must ensure that the returned pointer is never written to. If you need to mutate the contents of the string slice, use as_mut_ptr.

Examples

let s = "Hello";
let ptr = s.as_ptr();

pub fn get<I>(&self, i: I) -> Option<&<I as SliceIndex<str>>::Output>

where I: SliceIndex<str>,

Returns a subslice of str.

This is the non-panicking alternative to indexing the str. Returns None whenever equivalent indexing operation would panic.

Examples

let v = String::from("🗻∈🌏");

assert_eq!(Some("🗻"), v.get(0..4));

// indices not on UTF-8 sequence boundaries
assert!(v.get(1..).is_none());
assert!(v.get(..8).is_none());

// out of bounds
assert!(v.get(..42).is_none());

pub unsafe fn get_unchecked<I>(&self, i: I) -> &<I as SliceIndex<str>>::Output

where I: SliceIndex<str>,

Returns an unchecked subslice of str.

This is the unchecked alternative to indexing the str.

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original slice;
• Indexes must lie on UTF-8 sequence boundaries.

Failing that, the returned string slice may reference invalid memory or violate the invariants communicated by the str type.

Examples

let v = "🗻∈🌏";
unsafe {
    assert_eq!("🗻", v.get_unchecked(0..4));
    assert_eq!("∈", v.get_unchecked(4..7));
    assert_eq!("🌏", v.get_unchecked(7..11));
}

pub unsafe fn slice_unchecked(&self, begin: usize, end: usize) -> &str

👎Deprecated since 1.29.0:

use get_unchecked(begin..end) instead

Creates a string slice from another string slice, bypassing safety checks.

This is generally not recommended, use with caution! For a safe alternative see str and Index.

This new slice goes from begin to end, including begin but excluding end.

To get a mutable string slice instead, see the slice_mut_unchecked method.

Safety

Callers of this function are responsible that three preconditions are satisfied:

• begin must not exceed end.
• begin and end must be byte positions within the string slice.
• begin and end must lie on UTF-8 sequence boundaries.

Examples

let s = "Löwe 老虎 Léopard";

unsafe {
    assert_eq!("Löwe 老虎 Léopard", s.slice_unchecked(0, 21));
}

let s = "Hello, world!";

unsafe {
    assert_eq!("world", s.slice_unchecked(7, 12));
}

pub fn split_at(&self, mid: usize) -> (&str, &str)

Divides one string slice into two at an index.

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.

To get mutable string slices instead, see the split_at_mut method.

Panics

Panics if mid is not on a UTF-8 code point boundary, or if it is past the end of the last code point of the string slice. For a non-panicking alternative see split_at_checked.

Examples

let s = "Per Martin-Löf";

let (first, last) = s.split_at(3);

assert_eq!("Per", first);
assert_eq!(" Martin-Löf", last);

pub fn split_at_checked(&self, mid: usize) -> Option<(&str, &str)>

Divides one string slice into two at an index.

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.

To get mutable string slices instead, see the split_at_mut_checked method.

Examples

let s = "Per Martin-Löf";

let (first, last) = s.split_at_checked(3).unwrap();
assert_eq!("Per", first);
assert_eq!(" Martin-Löf", last);

assert_eq!(None, s.split_at_checked(13));  // Inside “ö”
assert_eq!(None, s.split_at_checked(16));  // Beyond the string length

pub fn chars(&self) -> Chars<'_>

Returns an iterator over the chars of a string slice.

As a string slice consists of valid UTF-8, we can iterate through a string slice by char. This method returns such an iterator.

It’s important to remember that char represents a Unicode Scalar Value, and might not match your idea of what a ‘character’ is. Iteration over grapheme clusters may be what you actually want. This functionality is not provided by Rust’s standard library, check crates.io instead.

Examples

Basic usage:

let word = "goodbye";

let count = word.chars().count();
assert_eq!(7, count);

let mut chars = word.chars();

assert_eq!(Some('g'), chars.next());
assert_eq!(Some('o'), chars.next());
assert_eq!(Some('o'), chars.next());
assert_eq!(Some('d'), chars.next());
assert_eq!(Some('b'), chars.next());
assert_eq!(Some('y'), chars.next());
assert_eq!(Some('e'), chars.next());

assert_eq!(None, chars.next());

Remember, chars might not match your intuition about characters:

let y = "y̆";

let mut chars = y.chars();

assert_eq!(Some('y'), chars.next()); // not 'y̆'
assert_eq!(Some('\u{0306}'), chars.next());

assert_eq!(None, chars.next());

pub fn char_indices(&self) -> CharIndices<'_>

Returns an iterator over the chars of a string slice, and their positions.

As a string slice consists of valid UTF-8, we can iterate through a string slice by char. This method returns an iterator of both these chars, as well as their byte positions.

The iterator yields tuples. The position is first, the char is second.

Examples

Basic usage:

let word = "goodbye";

let count = word.char_indices().count();
assert_eq!(7, count);

let mut char_indices = word.char_indices();

assert_eq!(Some((0, 'g')), char_indices.next());
assert_eq!(Some((1, 'o')), char_indices.next());
assert_eq!(Some((2, 'o')), char_indices.next());
assert_eq!(Some((3, 'd')), char_indices.next());
assert_eq!(Some((4, 'b')), char_indices.next());
assert_eq!(Some((5, 'y')), char_indices.next());
assert_eq!(Some((6, 'e')), char_indices.next());

assert_eq!(None, char_indices.next());

Remember, chars might not match your intuition about characters:

let yes = "y̆es";

let mut char_indices = yes.char_indices();

assert_eq!(Some((0, 'y')), char_indices.next()); // not (0, 'y̆')
assert_eq!(Some((1, '\u{0306}')), char_indices.next());

// note the 3 here - the previous character took up two bytes
assert_eq!(Some((3, 'e')), char_indices.next());
assert_eq!(Some((4, 's')), char_indices.next());

assert_eq!(None, char_indices.next());

pub fn bytes(&self) -> Bytes<'_>

Returns an iterator over the bytes of a string slice.

As a string slice consists of a sequence of bytes, we can iterate through a string slice by byte. This method returns such an iterator.

Examples

let mut bytes = "bors".bytes();

assert_eq!(Some(b'b'), bytes.next());
assert_eq!(Some(b'o'), bytes.next());
assert_eq!(Some(b'r'), bytes.next());
assert_eq!(Some(b's'), bytes.next());

assert_eq!(None, bytes.next());

pub fn split_whitespace(&self) -> SplitWhitespace<'_>

Splits a string slice by whitespace.

The iterator returned will return string slices that are sub-slices of the original string slice, separated by any amount of whitespace.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space. If you only want to split on ASCII whitespace instead, use split_ascii_whitespace.

Examples

Basic usage:

let mut iter = "A few words".split_whitespace();

assert_eq!(Some("A"), iter.next());
assert_eq!(Some("few"), iter.next());
assert_eq!(Some("words"), iter.next());

assert_eq!(None, iter.next());

All kinds of whitespace are considered:

let mut iter = " Mary   had\ta\u{2009}little  \n\t lamb".split_whitespace();
assert_eq!(Some("Mary"), iter.next());
assert_eq!(Some("had"), iter.next());
assert_eq!(Some("a"), iter.next());
assert_eq!(Some("little"), iter.next());
assert_eq!(Some("lamb"), iter.next());

assert_eq!(None, iter.next());

If the string is empty or all whitespace, the iterator yields no string slices:

assert_eq!("".split_whitespace().next(), None);
assert_eq!("   ".split_whitespace().next(), None);

pub fn split_ascii_whitespace(&self) -> SplitAsciiWhitespace<'_>

Splits a string slice by ASCII whitespace.

The iterator returned will return string slices that are sub-slices of the original string slice, separated by any amount of ASCII whitespace.

This uses the same definition as char::is_ascii_whitespace. To split by Unicode Whitespace instead, use split_whitespace. Note that because of this difference in definition, even if s.is_ascii() is true, s.split_ascii_whitespace() behavior will differ from s.split_whitespace() if s contains U+000B VERTICAL TAB.

Examples

Basic usage:

let mut iter = "A few words".split_ascii_whitespace();

assert_eq!(Some("A"), iter.next());
assert_eq!(Some("few"), iter.next());
assert_eq!(Some("words"), iter.next());

assert_eq!(None, iter.next());

Various kinds of ASCII whitespace are considered (see char::is_ascii_whitespace):

let mut iter = " Mary   had\ta little  \n\t lamb".split_ascii_whitespace();
assert_eq!(Some("Mary"), iter.next());
assert_eq!(Some("had"), iter.next());
assert_eq!(Some("a"), iter.next());
assert_eq!(Some("little"), iter.next());
assert_eq!(Some("lamb"), iter.next());

assert_eq!(None, iter.next());

If the string is empty or all ASCII whitespace, the iterator yields no string slices:

assert_eq!("".split_ascii_whitespace().next(), None);
assert_eq!("   ".split_ascii_whitespace().next(), None);

pub fn lines(&self) -> Lines<'_>

Returns an iterator over the lines of a string, as string slices.

Lines are split at line endings that are either newlines (\n) or sequences of a carriage return followed by a line feed (\r\n).

Line terminators are not included in the lines returned by the iterator.

Note that any carriage return (\r) not immediately followed by a line feed (\n) does not split a line. These carriage returns are thereby included in the produced lines.

The final line ending is optional. A string that ends with a final line ending will return the same lines as an otherwise identical string without a final line ending.

An empty string returns an empty iterator.

Examples

Basic usage:

let text = "foo\r\nbar\n\nbaz\r";
let mut lines = text.lines();

assert_eq!(Some("foo"), lines.next());
assert_eq!(Some("bar"), lines.next());
assert_eq!(Some(""), lines.next());
// Trailing carriage return is included in the last line
assert_eq!(Some("baz\r"), lines.next());

assert_eq!(None, lines.next());

The final line does not require any ending:

let text = "foo\nbar\n\r\nbaz";
let mut lines = text.lines();

assert_eq!(Some("foo"), lines.next());
assert_eq!(Some("bar"), lines.next());
assert_eq!(Some(""), lines.next());
assert_eq!(Some("baz"), lines.next());

assert_eq!(None, lines.next());

An empty string returns an empty iterator:

let text = "";
let mut lines = text.lines();

assert_eq!(lines.next(), None);

pub fn lines_any(&self) -> LinesAny<'_>

👎Deprecated since 1.4.0:

use lines() instead now

Returns an iterator over the lines of a string.

pub fn encode_utf16(&self) -> EncodeUtf16<'_>

Returns an iterator of u16 over the string encoded as native endian UTF-16 (without byte-order mark).

Examples

let text = "Zażółć gęślą jaźń";

let utf8_len = text.len();
let utf16_len = text.encode_utf16().count();

assert!(utf16_len <= utf8_len);

pub fn contains<P>(&self, pat: P) -> bool

where P: Pattern,

Returns true if the given pattern matches a sub-slice of this string slice.

Returns false if it does not.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let bananas = "bananas";

assert!(bananas.contains("nana"));
assert!(!bananas.contains("apples"));

pub fn starts_with<P>(&self, pat: P) -> bool

where P: Pattern,

Returns true if the given pattern matches a prefix of this string slice.

Returns false if it does not.

The pattern can be a &str, in which case this function will return true if the &str is a prefix of this string slice.

The pattern can also be a char, a slice of chars, or a function or closure that determines if a character matches. These will only be checked against the first character of this string slice. Look at the second example below regarding behavior for slices of chars.

Examples

let bananas = "bananas";

assert!(bananas.starts_with("bana"));
assert!(!bananas.starts_with("nana"));

let bananas = "bananas";

// Note that both of these assert successfully.
assert!(bananas.starts_with(&['b', 'a', 'n', 'a']));
assert!(bananas.starts_with(&['a', 'b', 'c', 'd']));

pub fn ends_with<P>(&self, pat: P) -> bool

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns true if the given pattern matches a suffix of this string slice.

Returns false if it does not.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let bananas = "bananas";

assert!(bananas.ends_with("anas"));
assert!(!bananas.ends_with("nana"));

pub fn find<P>(&self, pat: P) -> Option<usize>

where P: Pattern,

Returns the byte index of the first character of this string slice that matches the pattern.

Returns None if the pattern doesn’t match.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

Simple patterns:

let s = "Löwe 老虎 Léopard Gepardi";

assert_eq!(s.find('L'), Some(0));
assert_eq!(s.find('é'), Some(14));
assert_eq!(s.find("pard"), Some(17));

More complex patterns using point-free style and closures:

let s = "Löwe 老虎 Léopard";

assert_eq!(s.find(char::is_whitespace), Some(5));
assert_eq!(s.find(char::is_lowercase), Some(1));
assert_eq!(s.find(|c: char| c.is_whitespace() || c.is_lowercase()), Some(1));
assert_eq!(s.find(|c: char| (c < 'o') && (c > 'a')), Some(4));

Not finding the pattern:

let s = "Löwe 老虎 Léopard";
let x: &[_] = &['1', '2'];

assert_eq!(s.find(x), None);

pub fn rfind<P>(&self, pat: P) -> Option<usize>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns the byte index for the first character of the last match of the pattern in this string slice.

Returns None if the pattern doesn’t match.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

Simple patterns:

let s = "Löwe 老虎 Léopard Gepardi";

assert_eq!(s.rfind('L'), Some(13));
assert_eq!(s.rfind('é'), Some(14));
assert_eq!(s.rfind("pard"), Some(24));

More complex patterns with closures:

let s = "Löwe 老虎 Léopard";

assert_eq!(s.rfind(char::is_whitespace), Some(12));
assert_eq!(s.rfind(char::is_lowercase), Some(20));

Not finding the pattern:

let s = "Löwe 老虎 Léopard";
let x: &[_] = &['1', '2'];

assert_eq!(s.rfind(x), None);

pub fn split<P>(&self, pat: P) -> Split<'_, P>

where P: Pattern,

Returns an iterator over substrings of this string slice, separated by characters matched by a pattern.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

If there are no matches the full string slice is returned as the only item in the iterator.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rsplit method can be used.

Examples

Simple patterns:

let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();
assert_eq!(v, ["Mary", "had", "a", "little", "lamb"]);

let v: Vec<&str> = "".split('X').collect();
assert_eq!(v, [""]);

let v: Vec<&str> = "lionXXtigerXleopard".split('X').collect();
assert_eq!(v, ["lion", "", "tiger", "leopard"]);

let v: Vec<&str> = "lion::tiger::leopard".split("::").collect();
assert_eq!(v, ["lion", "tiger", "leopard"]);

let v: Vec<&str> = "AABBCC".split("DD").collect();
assert_eq!(v, ["AABBCC"]);

let v: Vec<&str> = "abc1def2ghi".split(char::is_numeric).collect();
assert_eq!(v, ["abc", "def", "ghi"]);

let v: Vec<&str> = "lionXtigerXleopard".split(char::is_uppercase).collect();
assert_eq!(v, ["lion", "tiger", "leopard"]);

If the pattern is a slice of chars, split on each occurrence of any of the characters:

let v: Vec<&str> = "2020-11-03 23:59".split(&['-', ' ', ':', '@'][..]).collect();
assert_eq!(v, ["2020", "11", "03", "23", "59"]);

A more complex pattern, using a closure:

let v: Vec<&str> = "abc1defXghi".split(|c| c == '1' || c == 'X').collect();
assert_eq!(v, ["abc", "def", "ghi"]);

If a string contains multiple contiguous separators, you will end up with empty strings in the output:

let x = "||||a||b|c".to_string();
let d: Vec<_> = x.split('|').collect();

assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);

Contiguous separators are separated by the empty string.

let x = "(///)".to_string();
let d: Vec<_> = x.split('/').collect();

assert_eq!(d, &["(", "", "", ")"]);

Separators at the start or end of a string are neighbored by empty strings.

let d: Vec<_> = "010".split("0").collect();
assert_eq!(d, &["", "1", ""]);

When the empty string is used as a separator, it separates every character in the string, along with the beginning and end of the string.

let f: Vec<_> = "rust".split("").collect();
assert_eq!(f, &["", "r", "u", "s", "t", ""]);

Contiguous separators can lead to possibly surprising behavior when whitespace is used as the separator. This code is correct:

let x = "    a  b c".to_string();
let d: Vec<_> = x.split(' ').collect();

assert_eq!(d, &["", "", "", "", "a", "", "b", "c"]);

It does not give you:

assert_eq!(d, &["a", "b", "c"]);

Use split_whitespace for this behavior.

pub fn split_inclusive<P>(&self, pat: P) -> SplitInclusive<'_, P>

where P: Pattern,

Returns an iterator over substrings of this string slice, separated by characters matched by a pattern.

Differs from the iterator produced by split in that split_inclusive leaves the matched part as the terminator of the substring.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let v: Vec<&str> = "Mary had a little lamb\nlittle lamb\nlittle lamb."
    .split_inclusive('\n').collect();
assert_eq!(v, ["Mary had a little lamb\n", "little lamb\n", "little lamb."]);

If the last element of the string is matched, that element will be considered the terminator of the preceding substring. That substring will be the last item returned by the iterator.

let v: Vec<&str> = "Mary had a little lamb\nlittle lamb\nlittle lamb.\n"
    .split_inclusive('\n').collect();
assert_eq!(v, ["Mary had a little lamb\n", "little lamb\n", "little lamb.\n"]);

pub fn rsplit<P>(&self, pat: P) -> RSplit<'_, P>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns an iterator over substrings of the given string slice, separated by characters matched by a pattern and yielded in reverse order.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be a DoubleEndedIterator if a forward/reverse search yields the same elements.

For iterating from the front, the split method can be used.

Examples

Simple patterns:

let v: Vec<&str> = "Mary had a little lamb".rsplit(' ').collect();
assert_eq!(v, ["lamb", "little", "a", "had", "Mary"]);

let v: Vec<&str> = "".rsplit('X').collect();
assert_eq!(v, [""]);

let v: Vec<&str> = "lionXXtigerXleopard".rsplit('X').collect();
assert_eq!(v, ["leopard", "tiger", "", "lion"]);

let v: Vec<&str> = "lion::tiger::leopard".rsplit("::").collect();
assert_eq!(v, ["leopard", "tiger", "lion"]);

A more complex pattern, using a closure:

let v: Vec<&str> = "abc1defXghi".rsplit(|c| c == '1' || c == 'X').collect();
assert_eq!(v, ["ghi", "def", "abc"]);

pub fn split_terminator<P>(&self, pat: P) -> SplitTerminator<'_, P>

where P: Pattern,

Returns an iterator over substrings of the given string slice, separated by characters matched by a pattern.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Equivalent to split, except that the trailing substring is skipped if empty.

This method can be used for string data that is terminated, rather than separated by a pattern.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rsplit_terminator method can be used.

Examples

let v: Vec<&str> = "A.B.".split_terminator('.').collect();
assert_eq!(v, ["A", "B"]);

let v: Vec<&str> = "A..B..".split_terminator(".").collect();
assert_eq!(v, ["A", "", "B", ""]);

let v: Vec<&str> = "A.B:C.D".split_terminator(&['.', ':'][..]).collect();
assert_eq!(v, ["A", "B", "C", "D"]);

pub fn rsplit_terminator<P>(&self, pat: P) -> RSplitTerminator<'_, P>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns an iterator over substrings of self, separated by characters matched by a pattern and yielded in reverse order.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Equivalent to split, except that the trailing substring is skipped if empty.

This method can be used for string data that is terminated, rather than separated by a pattern.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be double ended if a forward/reverse search yields the same elements.

For iterating from the front, the split_terminator method can be used.

Examples

let v: Vec<&str> = "A.B.".rsplit_terminator('.').collect();
assert_eq!(v, ["B", "A"]);

let v: Vec<&str> = "A..B..".rsplit_terminator(".").collect();
assert_eq!(v, ["", "B", "", "A"]);

let v: Vec<&str> = "A.B:C.D".rsplit_terminator(&['.', ':'][..]).collect();
assert_eq!(v, ["D", "C", "B", "A"]);

pub fn splitn<P>(&self, n: usize, pat: P) -> SplitN<'_, P>

where P: Pattern,

Returns an iterator over substrings of the given string slice, separated by a pattern, restricted to returning at most n items.

If n substrings are returned, the last substring (the nth substring) will contain the remainder of the string.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will not be double ended, because it is not efficient to support.

If the pattern allows a reverse search, the rsplitn method can be used.

Examples

Simple patterns:

let v: Vec<&str> = "Mary had a little lambda".splitn(3, ' ').collect();
assert_eq!(v, ["Mary", "had", "a little lambda"]);

let v: Vec<&str> = "lionXXtigerXleopard".splitn(3, "X").collect();
assert_eq!(v, ["lion", "", "tigerXleopard"]);

let v: Vec<&str> = "abcXdef".splitn(1, 'X').collect();
assert_eq!(v, ["abcXdef"]);

let v: Vec<&str> = "".splitn(1, 'X').collect();
assert_eq!(v, [""]);

A more complex pattern, using a closure:

let v: Vec<&str> = "abc1defXghi".splitn(2, |c| c == '1' || c == 'X').collect();
assert_eq!(v, ["abc", "defXghi"]);

pub fn rsplitn<P>(&self, n: usize, pat: P) -> RSplitN<'_, P>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns an iterator over substrings of this string slice, separated by a pattern, starting from the end of the string, restricted to returning at most n items.

If n substrings are returned, the last substring (the nth substring) will contain the remainder of the string.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will not be double ended, because it is not efficient to support.

For splitting from the front, the splitn method can be used.

Examples

Simple patterns:

let v: Vec<&str> = "Mary had a little lamb".rsplitn(3, ' ').collect();
assert_eq!(v, ["lamb", "little", "Mary had a"]);

let v: Vec<&str> = "lionXXtigerXleopard".rsplitn(3, 'X').collect();
assert_eq!(v, ["leopard", "tiger", "lionX"]);

let v: Vec<&str> = "lion::tiger::leopard".rsplitn(2, "::").collect();
assert_eq!(v, ["leopard", "lion::tiger"]);

A more complex pattern, using a closure:

let v: Vec<&str> = "abc1defXghi".rsplitn(2, |c| c == '1' || c == 'X').collect();
assert_eq!(v, ["ghi", "abc1def"]);

pub fn split_once<P>(&self, delimiter: P) -> Option<(&str, &str)>

where P: Pattern,

Splits the string on the first occurrence of the specified delimiter and returns prefix before delimiter and suffix after delimiter.

Examples

assert_eq!("cfg".split_once('='), None);
assert_eq!("cfg=".split_once('='), Some(("cfg", "")));
assert_eq!("cfg=foo".split_once('='), Some(("cfg", "foo")));
assert_eq!("cfg=foo=bar".split_once('='), Some(("cfg", "foo=bar")));

pub fn rsplit_once<P>(&self, delimiter: P) -> Option<(&str, &str)>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Splits the string on the last occurrence of the specified delimiter and returns prefix before delimiter and suffix after delimiter.

Examples

assert_eq!("cfg".rsplit_once('='), None);
assert_eq!("cfg=".rsplit_once('='), Some(("cfg", "")));
assert_eq!("cfg=foo".rsplit_once('='), Some(("cfg", "foo")));
assert_eq!("cfg=foo=bar".rsplit_once('='), Some(("cfg=foo", "bar")));

pub fn matches<P>(&self, pat: P) -> Matches<'_, P>

where P: Pattern,

Returns an iterator over the disjoint matches of a pattern within the given string slice.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rmatches method can be used.

Examples

let v: Vec<&str> = "abcXXXabcYYYabc".matches("abc").collect();
assert_eq!(v, ["abc", "abc", "abc"]);

let v: Vec<&str> = "1abc2abc3".matches(char::is_numeric).collect();
assert_eq!(v, ["1", "2", "3"]);

pub fn rmatches<P>(&self, pat: P) -> RMatches<'_, P>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns an iterator over the disjoint matches of a pattern within this string slice, yielded in reverse order.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be a DoubleEndedIterator if a forward/reverse search yields the same elements.

For iterating from the front, the matches method can be used.

Examples

let v: Vec<&str> = "abcXXXabcYYYabc".rmatches("abc").collect();
assert_eq!(v, ["abc", "abc", "abc"]);

let v: Vec<&str> = "1abc2abc3".rmatches(char::is_numeric).collect();
assert_eq!(v, ["3", "2", "1"]);

pub fn match_indices<P>(&self, pat: P) -> MatchIndices<'_, P>

where P: Pattern,

Returns an iterator over the disjoint matches of a pattern within this string slice as well as the index that the match starts at.

For matches of pat within self that overlap, only the indices corresponding to the first match are returned.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rmatch_indices method can be used.

Examples

let v: Vec<_> = "abcXXXabcYYYabc".match_indices("abc").collect();
assert_eq!(v, [(0, "abc"), (6, "abc"), (12, "abc")]);

let v: Vec<_> = "1abcabc2".match_indices("abc").collect();
assert_eq!(v, [(1, "abc"), (4, "abc")]);

let v: Vec<_> = "ababa".match_indices("aba").collect();
assert_eq!(v, [(0, "aba")]); // only the first `aba`

pub fn rmatch_indices<P>(&self, pat: P) -> RMatchIndices<'_, P>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns an iterator over the disjoint matches of a pattern within self, yielded in reverse order along with the index of the match.

For matches of pat within self that overlap, only the indices corresponding to the last match are returned.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be a DoubleEndedIterator if a forward/reverse search yields the same elements.

For iterating from the front, the match_indices method can be used.

Examples

let v: Vec<_> = "abcXXXabcYYYabc".rmatch_indices("abc").collect();
assert_eq!(v, [(12, "abc"), (6, "abc"), (0, "abc")]);

let v: Vec<_> = "1abcabc2".rmatch_indices("abc").collect();
assert_eq!(v, [(4, "abc"), (1, "abc")]);

let v: Vec<_> = "ababa".rmatch_indices("aba").collect();
assert_eq!(v, [(2, "aba")]); // only the last `aba`

pub fn trim(&self) -> &str

Returns a string slice with leading and trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

Examples

let s = "\n Hello\tworld\t\n";

assert_eq!("Hello\tworld", s.trim());

pub fn trim_start(&self) -> &str

Returns a string slice with leading whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

Text directionality

A string is a sequence of bytes. start in this context means the first position of that byte string; for a left-to-right language like English or Russian, this will be left side, and for right-to-left languages like Arabic or Hebrew, this will be the right side.

Examples

Basic usage:

let s = "\n Hello\tworld\t\n";
assert_eq!("Hello\tworld\t\n", s.trim_start());

Directionality:

let s = "  English  ";
assert!(Some('E') == s.trim_start().chars().next());

let s = "  עברית  ";
assert!(Some('ע') == s.trim_start().chars().next());

pub fn trim_end(&self) -> &str

Returns a string slice with trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space, which includes newlines.

Text directionality

A string is a sequence of bytes. end in this context means the last position of that byte string; for a left-to-right language like English or Russian, this will be right side, and for right-to-left languages like Arabic or Hebrew, this will be the left side.

Examples

Basic usage:

let s = "\n Hello\tworld\t\n";
assert_eq!("\n Hello\tworld", s.trim_end());

Directionality:

let s = "  English  ";
assert!(Some('h') == s.trim_end().chars().rev().next());

let s = "  עברית  ";
assert!(Some('ת') == s.trim_end().chars().rev().next());

pub fn trim_left(&self) -> &str

👎Deprecated since 1.33.0:

superseded by trim_start

Returns a string slice with leading whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

Text directionality

A string is a sequence of bytes. ‘Left’ in this context means the first position of that byte string; for a language like Arabic or Hebrew which are ‘right to left’ rather than ‘left to right’, this will be the right side, not the left.

Examples

Basic usage:

let s = " Hello\tworld\t";

assert_eq!("Hello\tworld\t", s.trim_left());

Directionality:

let s = "  English";
assert!(Some('E') == s.trim_left().chars().next());

let s = "  עברית";
assert!(Some('ע') == s.trim_left().chars().next());

pub fn trim_right(&self) -> &str

👎Deprecated since 1.33.0:

superseded by trim_end

Returns a string slice with trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

Text directionality

A string is a sequence of bytes. ‘Right’ in this context means the last position of that byte string; for a language like Arabic or Hebrew which are ‘right to left’ rather than ‘left to right’, this will be the left side, not the right.

Examples

Basic usage:

let s = " Hello\tworld\t";

assert_eq!(" Hello\tworld", s.trim_right());

Directionality:

let s = "English  ";
assert!(Some('h') == s.trim_right().chars().rev().next());

let s = "עברית  ";
assert!(Some('ת') == s.trim_right().chars().rev().next());

pub fn trim_matches<P>(&self, pat: P) -> &str

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> DoubleEndedSearcher<'a>,

Returns a string slice with all prefixes and suffixes that match a pattern repeatedly removed.

The pattern can be a char, a slice of chars, or a function or closure that determines if a character matches.

Examples

Simple patterns:

assert_eq!("11foo1bar11".trim_matches('1'), "foo1bar");
assert_eq!("123foo1bar123".trim_matches(char::is_numeric), "foo1bar");

let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_matches(x), "foo1bar");

A more complex pattern, using a closure:

assert_eq!("1foo1barXX".trim_matches(|c| c == '1' || c == 'X'), "foo1bar");

pub fn trim_start_matches<P>(&self, pat: P) -> &str

where P: Pattern,

Returns a string slice with all prefixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text directionality

A string is a sequence of bytes. start in this context means the first position of that byte string; for a left-to-right language like English or Russian, this will be left side, and for right-to-left languages like Arabic or Hebrew, this will be the right side.

Examples

assert_eq!("11foo1bar11".trim_start_matches('1'), "foo1bar11");
assert_eq!("123foo1bar123".trim_start_matches(char::is_numeric), "foo1bar123");

let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_start_matches(x), "foo1bar12");

pub fn strip_prefix<P>(&self, prefix: P) -> Option<&str>

where P: Pattern,

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.

If the string does not start with prefix, returns None.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

assert_eq!("foo:bar".strip_prefix("foo:"), Some("bar"));
assert_eq!("foo:bar".strip_prefix("bar"), None);
assert_eq!("foofoo".strip_prefix("foo"), Some("foo"));

pub fn strip_suffix<P>(&self, suffix: P) -> Option<&str>

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

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.

If the string does not end with suffix, returns None.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

assert_eq!("bar:foo".strip_suffix(":foo"), Some("bar"));
assert_eq!("bar:foo".strip_suffix("bar"), None);
assert_eq!("foofoo".strip_suffix("foo"), Some("foo"));

pub fn strip_circumfix<P, S>(&self, prefix: P, suffix: S) -> Option<&str>

where P: Pattern, S: Pattern, <S as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns a string slice with the prefix and suffix removed.

If the string starts with the pattern prefix and ends with the pattern suffix, and the prefix and suffix don’t overlap, returns the substring after the prefix and before the suffix, wrapped in Some. Unlike trim_start_matches and trim_end_matches, this method removes both the prefix and suffix exactly once.

If the string does not start with prefix, does not end with suffix, or the prefix and suffix overlap in the string, returns None.

Each pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

assert_eq!("bar:hello:foo".strip_circumfix("bar:", ":foo"), Some("hello"));
assert_eq!("bar:foo".strip_circumfix("foo", "foo"), None);
assert_eq!("foo:bar;".strip_circumfix("foo:", ';'), Some("bar"));
assert_eq!("foo:bar:baz".strip_circumfix("foo:bar:", ":bar:baz"), None);

pub fn trim_prefix<P>(&self, prefix: P) -> &str

where P: Pattern,

🔬This is a nightly-only experimental API. (trim_prefix_suffix)

Returns a string slice with the optional prefix removed.

If the string starts with the pattern prefix, returns the substring after the prefix. Unlike strip_prefix, this method always returns &str for easy method chaining, instead of returning Option<&str>.

If the string does not start with prefix, returns the original string unchanged.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

#![feature(trim_prefix_suffix)]

// Prefix present - removes it
assert_eq!("foo:bar".trim_prefix("foo:"), "bar");
assert_eq!("foofoo".trim_prefix("foo"), "foo");

// Prefix absent - returns original string
assert_eq!("foo:bar".trim_prefix("bar"), "foo:bar");

// Method chaining example
assert_eq!("<https://example.com/>".trim_prefix('<').trim_suffix('>'), "https://example.com/");

pub fn trim_suffix<P>(&self, suffix: P) -> &str

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

🔬This is a nightly-only experimental API. (trim_prefix_suffix)

Returns a string slice with the optional suffix removed.

If the string ends with the pattern suffix, returns the substring before the suffix. Unlike strip_suffix, this method always returns &str for easy method chaining, instead of returning Option<&str>.

If the string does not end with suffix, returns the original string unchanged.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

#![feature(trim_prefix_suffix)]

// Suffix present - removes it
assert_eq!("bar:foo".trim_suffix(":foo"), "bar");
assert_eq!("foofoo".trim_suffix("foo"), "foo");

// Suffix absent - returns original string
assert_eq!("bar:foo".trim_suffix("bar"), "bar:foo");

// Method chaining example
assert_eq!("<https://example.com/>".trim_prefix('<').trim_suffix('>'), "https://example.com/");

pub fn trim_end_matches<P>(&self, pat: P) -> &str

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

Returns a string slice with all suffixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text directionality

A string is a sequence of bytes. end in this context means the last position of that byte string; for a left-to-right language like English or Russian, this will be right side, and for right-to-left languages like Arabic or Hebrew, this will be the left side.

Examples

Simple patterns:

assert_eq!("11foo1bar11".trim_end_matches('1'), "11foo1bar");
assert_eq!("123foo1bar123".trim_end_matches(char::is_numeric), "123foo1bar");

let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_end_matches(x), "12foo1bar");

A more complex pattern, using a closure:

assert_eq!("1fooX".trim_end_matches(|c| c == '1' || c == 'X'), "1foo");

pub fn trim_left_matches<P>(&self, pat: P) -> &str

where P: Pattern,

👎Deprecated since 1.33.0:

superseded by trim_start_matches

Returns a string slice with all prefixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text directionality

A string is a sequence of bytes. ‘Left’ in this context means the first position of that byte string; for a language like Arabic or Hebrew which are ‘right to left’ rather than ‘left to right’, this will be the right side, not the left.

Examples

assert_eq!("11foo1bar11".trim_left_matches('1'), "foo1bar11");
assert_eq!("123foo1bar123".trim_left_matches(char::is_numeric), "foo1bar123");

let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_left_matches(x), "foo1bar12");

pub fn trim_right_matches<P>(&self, pat: P) -> &str

where P: Pattern, <P as Pattern>::Searcher<'a>: for<'a> ReverseSearcher<'a>,

👎Deprecated since 1.33.0:

superseded by trim_end_matches

Returns a string slice with all suffixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text directionality

A string is a sequence of bytes. ‘Right’ in this context means the last position of that byte string; for a language like Arabic or Hebrew which are ‘right to left’ rather than ‘left to right’, this will be the left side, not the right.

Examples

Simple patterns:

assert_eq!("11foo1bar11".trim_right_matches('1'), "11foo1bar");
assert_eq!("123foo1bar123".trim_right_matches(char::is_numeric), "123foo1bar");

let x: &[_] = &['1', '2'];
assert_eq!("12foo1bar12".trim_right_matches(x), "12foo1bar");

A more complex pattern, using a closure:

assert_eq!("1fooX".trim_right_matches(|c| c == '1' || c == 'X'), "1foo");

pub fn parse<F>(&self) -> Result<F, <F as FromStr>::Err>

where F: FromStr,

Parses this string slice into another type.

Because parse is so general, it can cause problems with type inference. As such, parse is one of the few times you’ll see the syntax affectionately known as the ‘turbofish’: ::<>. This helps the inference algorithm understand specifically which type you’re trying to parse into.

parse can parse into any type that implements the FromStr trait.

Errors

Will return Err if it’s not possible to parse this string slice into the desired type.

Examples

Basic usage:

let four: u32 = "4".parse().unwrap();

assert_eq!(4, four);

Using the ‘turbofish’ instead of annotating four:

let four = "4".parse::<u32>();

assert_eq!(Ok(4), four);

Failing to parse:

let nope = "j".parse::<u32>();

assert!(nope.is_err());

pub fn is_ascii(&self) -> bool

Checks if all characters in this string are within the ASCII range.

An empty string returns true.

Examples

let ascii = "hello!\n";
let non_ascii = "Grüße, Jürgen ❤";

assert!(ascii.is_ascii());
assert!(!non_ascii.is_ascii());

pub fn as_ascii(&self) -> Option<&[AsciiChar]>

🔬This is a nightly-only experimental API. (ascii_char)

If this string slice is_ascii, returns it as a slice of ASCII characters, otherwise returns None.

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this string slice into a slice of ASCII characters, without checking whether they are valid.

Safety

Every character in this string must be ASCII, or else this is UB.

pub fn eq_ignore_ascii_case(&self, other: &str) -> bool

Checks that two strings are an ASCII case-insensitive match.

Same as to_ascii_lowercase(a) == to_ascii_lowercase(b), but without allocating and copying temporaries.

For Unicode-aware case-insensitive matching, consider str::eq_ignore_case_unnormalized.

Examples

assert!("Ferris".eq_ignore_ascii_case("FERRIS"));
assert!("Ferrös".eq_ignore_ascii_case("FERRöS"));
assert!(!"Ferrös".eq_ignore_ascii_case("FERRÖS"));

pub fn eq_ignore_case_unnormalized(&self, other: &str) -> bool

🔬This is a nightly-only experimental API. (casefold)

Checks that two strings are a caseless match, according to Definition 144 in Chapter 3 of the Unicode Standard.

Same as a.to_casefold_unnormalized() == b.to_casefold_unnormalized(), but without allocating. See that method’s documentation, as well as char::to_casefold_unnormalized(), for more information about case folding.

No normalization (e.g. NFC) is performed, so visually and semantically identical strings might still compare unequal. For example, "Å" (U+00C5 LATIN CAPITAL LETTER A WITH RING ABOVE) is considered distinct from "Å" (A followed by U+030A COMBINING RING ABOVE), even though Unicode considers them canonically equivalent.

In addition, this method is independent of language/locale, so the special behavior of I/ı/İ/i in Turkish and Azeri is not handled.

Examples

#![feature(casefold)]
assert!("Ferris".eq_ignore_case_unnormalized("FERRIS"));
assert!("Ferrös".eq_ignore_case_unnormalized("FERRÖS"));
assert!("ẞ".eq_ignore_case_unnormalized("ss"));

No NFC normalization is performed:

#![feature(casefold)]
// These two strings are visually and semantically identical...
let comp = "Å";
let decomp = "Å";

// ... but not codepoint-for-codepoint equal.
assert_eq!(comp, "\u{C5}");
assert_eq!(decomp, "A\u{030A}");

// Their case-foldings are likewise unequal:
assert!(!comp.eq_ignore_case_unnormalized(decomp));

pub fn trim_ascii_start(&self) -> &str

Returns a string slice with leading ASCII whitespace removed.

‘Whitespace’ refers to the definition used by u8::is_ascii_whitespace. Importantly, this definition excludes the U+000B code point even though it has the Unicode White_Space property and is removed by str::trim_start.

Examples

assert_eq!(" \t \u{3000}hello world\n".trim_ascii_start(), "\u{3000}hello world\n");
assert_eq!("  ".trim_ascii_start(), "");
assert_eq!("".trim_ascii_start(), "");

pub fn trim_ascii_end(&self) -> &str

Returns a string slice with trailing ASCII whitespace removed.

‘Whitespace’ refers to the definition used by u8::is_ascii_whitespace. Importantly, this definition excludes the U+000B code point even though it has the Unicode White_Space property and is removed by str::trim_end.

Examples

assert_eq!("\r hello world\u{3000}\n ".trim_ascii_end(), "\r hello world\u{3000}");
assert_eq!("  ".trim_ascii_end(), "");
assert_eq!("".trim_ascii_end(), "");

pub fn trim_ascii(&self) -> &str

Returns a string slice with leading and trailing ASCII whitespace removed.

‘Whitespace’ refers to the definition used by u8::is_ascii_whitespace. Importantly, this definition excludes the U+000B code point even though it has the Unicode White_Space property and is removed by str::trim.

Examples

assert_eq!("\r hello world\n ".trim_ascii(), "hello world");
assert_eq!("  ".trim_ascii(), "");
assert_eq!("".trim_ascii(), "");

pub fn escape_debug(&self) -> EscapeDebug<'_>

Returns an iterator that escapes each char in self with char::escape_debug.

Note: only extended grapheme codepoints that begin the string will be escaped.

Examples

As an iterator:

for c in "❤\n!".escape_debug() {
    print!("{c}");
}
println!();

Using println! directly:

println!("{}", "❤\n!".escape_debug());

Both are equivalent to:

println!("❤\\n!");

Using to_string:

assert_eq!("❤\n!".escape_debug().to_string(), "❤\\n!");

pub fn escape_default(&self) -> EscapeDefault<'_>

Returns an iterator that escapes each char in self with char::escape_default.

Examples

As an iterator:

for c in "❤\n!".escape_default() {
    print!("{c}");
}
println!();

Using println! directly:

println!("{}", "❤\n!".escape_default());

Both are equivalent to:

println!("\\u{{2764}}\\n!");

Using to_string:

assert_eq!("❤\n!".escape_default().to_string(), "\\u{2764}\\n!");

pub fn escape_unicode(&self) -> EscapeUnicode<'_>

Returns an iterator that escapes each char in self with char::escape_unicode.

Examples

As an iterator:

for c in "❤\n!".escape_unicode() {
    print!("{c}");
}
println!();

Using println! directly:

println!("{}", "❤\n!".escape_unicode());

Both are equivalent to:

println!("\\u{{2764}}\\u{{a}}\\u{{21}}");

Using to_string:

assert_eq!("❤\n!".escape_unicode().to_string(), "\\u{2764}\\u{a}\\u{21}");

pub fn substr_range(&self, substr: &str) -> Option<Range<usize>>

Returns the range that a substring points to.

Returns None if substr does not point within self.

Unlike str::find, this does not search through the string. Instead, it uses pointer arithmetic to find where in the string substr is derived from.

This is useful for extending str::split and similar methods.

Note that this method may return false positives (typically either Some(0..0) or Some(self.len()..self.len())) if substr is a zero-length str that points at the beginning or end of another, independent, str.

Examples

use core::range::Range;

let data = "a, b, b, a";
let mut iter = data.split(", ").map(|s| data.substr_range(s).unwrap());

assert_eq!(iter.next(), Some(Range { start: 0, end: 1 }));
assert_eq!(iter.next(), Some(Range { start: 3, end: 4 }));
assert_eq!(iter.next(), Some(Range { start: 6, end: 7 }));
assert_eq!(iter.next(), Some(Range { start: 9, end: 10 }));

pub fn as_str(&self) -> &str

🔬This is a nightly-only experimental API. (str_as_str)

Returns the same string as a string slice &str.

This method is redundant when used directly on &str, but it helps dereferencing other string-like types to string slices, for example references to Box<str> or Arc<str>.

pub fn replace<P>(&self, from: P, to: &str) -> String

where P: Pattern,

Available on non-no_global_oom_handling only.

Replaces all matches of a pattern with another string.

replace creates a new String, and copies the data from this string slice into it. While doing so, it attempts to find matches of a pattern. If it finds any, it replaces them with the replacement string slice.

Examples

let s = "this is old";

assert_eq!("this is new", s.replace("old", "new"));
assert_eq!("than an old", s.replace("is", "an"));

When the pattern doesn’t match, it returns this string slice as String:

let s = "this is old";
assert_eq!(s, s.replace("cookie monster", "little lamb"));

pub fn replacen<P>(&self, pat: P, to: &str, count: usize) -> String

where P: Pattern,

Available on non-no_global_oom_handling only.

Replaces first N matches of a pattern with another string.

replacen creates a new String, and copies the data from this string slice into it. While doing so, it attempts to find matches of a pattern. If it finds any, it replaces them with the replacement string slice at most count times.

Examples

let s = "foo foo 123 foo";
assert_eq!("new new 123 foo", s.replacen("foo", "new", 2));
assert_eq!("faa fao 123 foo", s.replacen('o', "a", 3));
assert_eq!("foo foo new23 foo", s.replacen(char::is_numeric, "new", 1));

When the pattern doesn’t match, it returns this string slice as String:

let s = "this is old";
assert_eq!(s, s.replacen("cookie monster", "little lamb", 10));

pub fn to_lowercase(&self) -> String

Available on non-no_global_oom_handling only.

Returns the lowercase equivalent of this string slice, as a new String.

‘Lowercase’ is defined according to the terms of Chapter 3 (Conformance) of the Unicode standard.

Since some characters can expand into multiple characters when changing the case, this function returns a String instead of modifying the parameter in-place.

Unlike char::to_lowercase(), this method fully handles the context-dependent casing of Greek sigma. However, like that method, it does not handle locale-specific casing, like Turkish and Azeri I/ı/İ/i. See its documentation for more information.

Examples

Basic usage:

let s = "HELLO WORLD";

assert_eq!("hello world", s.to_lowercase());

Tricky examples, with sigma:

let sigma = "Σ";

assert_eq!("σ", sigma.to_lowercase());

// but at the end of a word, it's ς, not σ:
let odysseus = "ὈΔΥΣΣΕΎΣ";

assert_eq!("ὀδυσσεύς", odysseus.to_lowercase());

let odysseus_king_of_ithaca = "Ο ΟΔΥΣΣΈΑΣ ΒΑΣΙΛΙΆΣ ΤΗΣ ΙΘΆΚΗΣ";

assert_eq!("ο οδυσσέας βασιλιάς της ιθάκης", odysseus_king_of_ithaca.to_lowercase());

Languages without case are not changed:

let new_year = "农历新年";

assert_eq!(new_year, new_year.to_lowercase());

pub fn word_to_titlecase(&self) -> String

🔬This is a nightly-only experimental API. (titlecase)

Available on non-no_global_oom_handling only.

Returns the titlecase equivalent of this string slice, which is assumed to represent a single word, as a new String.

Essentially, this consists of uppercasing the first cased letter (with char::to_titlecase()), and lowercasing everything that follows.

‘Titlecase’ is defined according to the terms of Chapter 3 (Conformance) of the Unicode standard.

Since some characters can expand into multiple characters when changing the case, this function returns a String instead of modifying the parameter in-place.

Unlike char::to_lowercase(), this method fully handles the context-dependent casing of Greek sigma. However, like that method, it does not handle locale-specific casing, like Turkish and Azeri I/ı/İ/i. See its documentation for more information.

This method does not perform any kind of word segmentation.

Examples

Basic usage:

#![feature(titlecase)]
let s = "HELLO WORLD";

assert_eq!("Hello world", s.word_to_titlecase());

The first cased letter is uppercased:

#![feature(titlecase)]
let the_night_before_christmas = "'twas";

assert_eq!("'Twas", the_night_before_christmas.word_to_titlecase());

Languages without case are not changed:

#![feature(titlecase)]
let new_year = "农历新年";

assert_eq!(new_year, new_year.word_to_titlecase());

Georgian uppercase (“Mtavruli”) letters are not used in titlecase:

#![feature(titlecase)]
let georgian = "ერთობაშია";

assert_eq!(georgian, georgian.word_to_titlecase());

No word segmentation is performed, so only the first cased letter in the whole string gets uppercased:

#![feature(titlecase)]
let blazingly_fast = "ferris and I";

assert_eq!("Ferris and i", blazingly_fast.word_to_titlecase());

Tricky examples, with sigma:

#![feature(titlecase)]
let odysseus = "ὈΔΥΣΣΕΎΣ";

assert_eq!("Ὀδυσσεύς", odysseus.word_to_titlecase());

let odysseus_king_of_ithaca = "Ο ΟΔΥΣΣΈΑΣ ΒΑΣΙΛΙΆΣ ΤΗΣ ΙΘΆΚΗΣ";

assert_eq!("Ο οδυσσέας βασιλιάς της ιθάκης", odysseus_king_of_ithaca.word_to_titlecase());

pub fn to_uppercase(&self) -> String

Available on non-no_global_oom_handling only.

Returns the uppercase equivalent of this string slice, as a new String.

‘Uppercase’ is defined according to the terms of Chapter 3 (Conformance) of the Unicode standard.

Since some characters can expand into multiple characters when changing the case, this function returns a String instead of modifying the parameter in-place.

Like char::to_uppercase() this method does not handle language-specific casing, like Turkish and Azeri I/ı/İ/i. See that method’s documentation for more information.

Examples

Basic usage:

let s = "hello world";

assert_eq!("HELLO WORLD", s.to_uppercase());

Scripts without case are not changed:

let new_year = "农历新年";

assert_eq!(new_year, new_year.to_uppercase());

One character can become multiple:

let s = "tschüß";

assert_eq!("TSCHÜSS", s.to_uppercase());

pub fn to_casefold_unnormalized(&self) -> String

🔬This is a nightly-only experimental API. (casefold)

Available on non-no_global_oom_handling only.

Returns the case-folded equivalent of this string slice, as a new String.

Case folding is a transformation, mostly matching lowercase, that is meant to be used for case-insensitive string comparisons. Case-folded strings should not usually be exposed directly to users.

For the precise specification of case folding, see Chapter 3 (Conformance) of the Unicode standard.

Since some characters can expand into multiple characters when case folding, this function returns a String instead of modifying the parameter in-place.

No normalization (e.g. NFC) is performed, so visually and semantically identical strings might still casefold differently. For example, "Å" (U+00C5 LATIN CAPITAL LETTER A WITH RING ABOVE) is considered distinct from "Å" (A followed by U+030A COMBINING RING ABOVE), even though Unicode considers them canonically equivalent.

Like char::to_casefold_unnormalized() this method does not handle language-specific casing, like Turkish and Azeri I/ı/İ/i. See that method’s documentation for more information.

Examples

Basic usage:

#![feature(casefold)]
let s0 = "HELLO";
let s1 = "Hello";

assert_eq!(s0.to_casefold_unnormalized(), s1.to_casefold_unnormalized());
assert_eq!(s0.to_casefold_unnormalized(), "hello")

Scripts without case are not changed:

#![feature(casefold)]
let new_year = "农历新年";

assert_eq!(new_year, new_year.to_casefold_unnormalized());

One character can become multiple:

#![feature(casefold)]
let s0 = "TSCHÜẞ";
let s1 = "TSCHÜSS";
let s2 = "tschüß";

assert_eq!(s0.to_casefold_unnormalized(), s1.to_casefold_unnormalized());
assert_eq!(s0.to_casefold_unnormalized(), s2.to_casefold_unnormalized());
assert_eq!(s0.to_casefold_unnormalized(), "tschüss");

No NFC normalization is performed:

#![feature(casefold)]
// These two strings are visually and semantically identical...
let comp = "Å";
let decomp = "Å";

// ... but not codepoint-for-codepoint equal.
assert_eq!(comp, "\u{C5}");
assert_eq!(decomp, "A\u{030A}");

// Their case-foldings are likewise unequal:
assert_eq!(comp.to_casefold_unnormalized(), "\u{E5}");
assert_eq!(decomp.to_casefold_unnormalized(), "a\u{030A}");

pub fn repeat(&self, n: usize) -> String

Available on non-no_global_oom_handling only.

Creates a new String by repeating a string n times.

Panics

This function will panic if the capacity would overflow.

Examples

Basic usage:

assert_eq!("abc".repeat(4), String::from("abcabcabcabc"));

A panic upon overflow:

// this will panic at runtime
let huge = "0123456789abcdef".repeat(usize::MAX);

pub fn to_ascii_uppercase(&self) -> String

Available on non-no_global_oom_handling only.

Returns a copy of this string where each character is mapped to its ASCII upper case equivalent.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To uppercase the value in-place, use make_ascii_uppercase.

To uppercase ASCII characters in addition to non-ASCII characters, use to_uppercase.

Examples

let s = "Grüße, Jürgen ❤";

assert_eq!("GRüßE, JüRGEN ❤", s.to_ascii_uppercase());

pub fn to_ascii_lowercase(&self) -> String

Available on non-no_global_oom_handling only.

Returns a copy of this string where each character is mapped to its ASCII lower case equivalent.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

To lowercase the value in-place, use make_ascii_lowercase.

To lowercase ASCII characters in addition to non-ASCII characters, use to_lowercase.

Examples

let s = "Grüße, Jürgen ❤";

assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());

Trait Implementations

impl Add<&str> for CharString

type Output = CharString

The resulting type after applying the + operator.

fn add(self, rhs: &str) -> Self::Output

Performs the + operation.

impl AddAssign<&str> for CharString

fn add_assign(&mut self, rhs: &str)

Performs the += operation.

impl<'a> Arbitrary<'a> for CharString

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl AsRef<OsStr> for CharString

Available on crate feature std only.

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8]> for CharString

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

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for CharString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<str> for CharString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CharString

A Clone implementation for CharString.

The clone operation is performed using a reference counting mechanism, which means:

• The cloned string shares the same underlying data with the original string
• The cloning process is very efficient (O(1) time complexity)
• No memory allocation occurs during cloning

Examples

let s1 = CharString::from("Hello, World!");
let s2 = s1.clone();

assert_eq!(s1, s2);

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CharString

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

Formats the value using the given formatter.

impl Default for CharString

fn default() -> Self

Returns the “default value” for a type.

impl Deref for CharString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'de> Deserialize<'de> for CharString

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for CharString

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

Formats the value using the given formatter.

impl Drop for CharString

A Drop implementation for CharString.

If the string is heap-allocated, dropping it decrements the reference count and frees the heap memory when the last reference is dropped.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for CharString

impl<'a> Extend<&'a char> for CharString

fn extend<T: IntoIterator<Item = &'a char>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<&'a str> for CharString

fn extend<T: IntoIterator<Item = &'a str>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Box<str>> for CharString

fn extend<T: IntoIterator<Item = Box<str>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<CharString> for CharString

fn extend<T: IntoIterator<Item = CharString>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<CharString> for String

fn extend<T: IntoIterator<Item = CharString>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<Cow<'a, str>> for CharString

fn extend<T: IntoIterator<Item = Cow<'a, str>>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<String> for CharString

fn extend<T: IntoIterator<Item = String>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<char> for CharString

fn extend<T: IntoIterator<Item = char>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&CharString> for CharString

fn from(value: &CharString) -> Self

Converts to this type from the input type.

impl From<&CharString> for String

fn from(value: &CharString) -> Self

Converts to this type from the input type.

impl From<&String> for CharString

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for CharString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Box<str>> for CharString

fn from(value: Box<str>) -> Self

Converts to this type from the input type.

impl From<CharStr> for CharString

fn from(value: CharStr) -> Self

Converts to this type from the input type.

impl From<CharString> for CharStr

fn from(value: CharString) -> Self

Converts to this type from the input type.

impl From<CharString> for String

fn from(value: CharString) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for CharString

fn from(cow: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<String> for CharString

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<char> for CharString

fn from(value: char) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a char> for CharString

fn from_iter<T: IntoIterator<Item = &'a char>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<&'a str> for CharString

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<Box<str>> for CharString

fn from_iter<I: IntoIterator<Item = Box<str>>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<CharString> for CharString

fn from_iter<T: IntoIterator<Item = CharString>>(iter: T) -> Self

Creates a value from an iterator.

impl<'a> FromIterator<Cow<'a, str>> for CharString

fn from_iter<I: IntoIterator<Item = Cow<'a, str>>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<String> for CharString

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> Self

Creates a value from an iterator.

impl FromIterator<char> for CharString

fn from_iter<T: IntoIterator<Item = char>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for CharString

type Err = ReserveError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl GetSize for CharString

Available on crate feature get-size only.

fn get_heap_size_with_tracker<T: GetSizeTracker>( &self, tracker: T, ) -> (usize, T)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl Hash for CharString

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LifetimeFree for CharString

impl Ord for CharString

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CharString

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<&str> for CharString

fn eq(&self, other: &&str) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharStr> for CharString

fn eq(&self, other: &CharStr) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharString> for CharStr

fn eq(&self, other: &CharString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharString> for str

fn eq(&self, other: &CharString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharString> for &str

fn eq(&self, other: &CharString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharString> for String

fn eq(&self, other: &CharString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<CharString> for Cow<'_, str>

fn eq(&self, other: &CharString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<Cow<'_, str>> for CharString

fn eq(&self, other: &Cow<'_, str>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<String> for CharString

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<str> for CharString

fn eq(&self, other: &str) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for CharString

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for CharString

impl Serialize for CharString

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sync for CharString

impl Update for CharString

Available on crate feature salsa only.

unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool

Returns

impl Write for CharString

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result

Glue for usage of the write! macro with implementors of this trait.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.