Struct corundum::str::String [−][src]
pub struct String<A: MemPool> { /* fields omitted */ }
Expand description
A UTF-8 encoded, growable string.
The String
type is persistent string type that has ownership over the
contents of the string. It has a close relationship with its borrowed
counterpart, the primitive str
.
PString
is an alias name in the pool module for String
.
Examples
You can create a String
from a literal string with String::from
:
Heap::transaction(|j| { let hello = String::<Heap>::pfrom("Hello, world!", j); }).unwrap();
You can append a char
to a String
with the push
method, and
append a &str
with the push_str
method:
Heap::transaction(|j| { let mut hello = String::<Heap>::pfrom("Hello, ", j); hello.push('w', j); hello.push_str("orld!", j); }).unwrap();
If you have a vector of UTF-8 bytes, you can create a String
from it with
the from_utf8
method:
Heap::transaction(|j| { // some bytes, in a vector let sparkle_heart = vec![240, 159, 146, 150]; // We know these bytes are valid, so we'll use `unwrap()`. let sparkle_heart = String::from_utf8(sparkle_heart, j).unwrap(); assert_eq!("💖", sparkle_heart); }).unwrap();
UTF-8
String
s are always valid UTF-8. This has a few implications, the first of
which is that if you need a non-UTF-8 string, consider OsString
. It is
similar, but without the UTF-8 constraint. The second implication is that
you cannot index into a String
:
let s = "hello"; println!("The first letter of s is {}", s[0]); // ERROR!!!
Indexing is intended to be a constant-time operation, but UTF-8 encoding
does not allow us to do this. Furthermore, it’s not clear what sort of
thing the index should return: a byte, a codepoint, or a grapheme cluster.
The bytes
and chars
methods return iterators over the first
two, respectively.
Deref
String
s implement Deref
<Target=str>
, and so inherit all of str
’s
methods. In addition, this means that you can pass a String
to a
function which takes a &str
by using an ampersand (&
):
fn takes_str(s: &str) { } Heap::transaction(|j| { let s = String::<Heap>::pfrom("Hello", j); takes_str(&s); }).unwrap();
Implementations
Creates a new empty String
.
Given that the String
is empty, this will not allocate any initial
buffer. While that means that this initial operation is very
inexpensive, it may cause excessive allocation later when you add
data. If you have an idea of how much data the String
will hold,
consider the with_capacity
method to prevent excessive
re-allocation.
Examples
Basic usage:
Heap::transaction(|j| { let s = PString::new(); }).unwrap();
Creates a new empty String
with a particular capacity.
String
s have an internal buffer to hold their data. The capacity is
the length of that buffer, and can be queried with the capacity
method. This method creates an empty String
, but one with an initial
buffer that can hold capacity
bytes. This is useful when you may be
appending a bunch of data to the String
, reducing the number of
reallocations it needs to do.
If the given capacity is 0
, no allocation will occur, and this method
is identical to the new
method.
Examples
Basic usage:
Heap::transaction(|j| { let mut s = String::with_capacity(10, j); // The String<A> contains no chars, even though it has capacity for more assert_eq!(s.len(), 0); // These are all done without reallocating... let cap = s.capacity(); for _ in 0..10 { s.push('a', j); } assert_eq!(s.capacity(), cap); // ...but this may make the string reallocate s.push('a', j); }).unwrap();
Creates a String
from &str
s
may be in the volatile heap. PStrong::from_str
will allocate enough
space in pool A
and places s
into it an make a String
out of it.
Example
let hello = "Hello World!!!"; Heap::transaction(|j| { let phello = String::from_str(hello, j); assert_eq!(hello, phello); }).unwrap();
Converts a vector of bytes to a String
.
A string (String
) is made of bytes (u8
), and a vector of bytes
(Vec<u8>
) is made of bytes, so this function converts between the
two. Not all byte slices are valid String
s, however: String
requires that it is valid UTF-8. from_utf8()
checks to ensure that
the bytes are valid UTF-8, and then does the conversion.
If you are sure that the byte slice is valid UTF-8, and you don’t want
to incur the overhead of the validity check, there is an unsafe version
of this function, from_utf8_unchecked
, which has the same behavior
but skips the check.
This method will take care to not copy the vector, for efficiency’s sake.
If you need a &str
instead of a String
, consider
str::from_utf8
.
The inverse of this method is into_bytes
.
Errors
Returns Err
if the slice is not UTF-8 with a description as to why the
provided bytes are not UTF-8. The vector you moved in is also included.
Examples
Basic usage:
// some bytes, in a vector let sparkle_heart = vec![240, 159, 146, 150]; Heap::transaction(|j| { // We know these bytes are valid, so we'll use `unwrap()`. let sparkle_heart = String::from_utf8(sparkle_heart, j).unwrap(); assert_eq!("💖", sparkle_heart); }).unwrap();
Incorrect bytes:
Heap::transaction(|j| { // some invalid bytes, in a vector let sparkle_heart = vec![0, 159, 146, 150]; assert!(String::from_utf8(sparkle_heart, j).is_err()); }).unwrap();
See the docs for FromUtf8Error
for more details on what you can do
with this error.
Converts a slice of bytes to a persistent string, including invalid characters.
Strings are made of bytes (u8
), and a slice of bytes
(&[u8]
) is made of bytes, so this function converts
between the two. Not all byte slices are valid strings, however: strings
are required to be valid UTF-8. During this conversion,
from_utf8_lossy()
will replace any invalid UTF-8 sequences with
U+FFFD REPLACEMENT CHARACTER
, which looks like this: �
If you are sure that the byte slice is valid UTF-8, and you don’t want
to incur the overhead of the conversion, there is an unsafe version
of this function, from_utf8_unchecked
, which has the same behavior
but skips the checks.
This function returns a Cow<'a, str>
. If our byte slice is invalid
UTF-8, then we need to insert the replacement characters, which will
change the size of the string, and hence, require a String
. But if
it’s already valid UTF-8, we don’t need a new allocation. This return
type allows us to handle both cases.
Examples
Basic usage:
// some bytes, in a vector let sparkle_heart = vec![240, 159, 146, 150]; Heap::transaction(|j| { let sparkle_heart = String::from_utf8_lossy(&sparkle_heart, j); assert_eq!("💖", sparkle_heart); }).unwrap();
Incorrect bytes:
Heap::transaction(|j| { // some invalid bytes let input = b"Hello \xF0\x90\x80World"; let output = String::from_utf8_lossy(input, j); assert_eq!("Hello �World", output); }).unwrap();
Decode a UTF-16 encoded vector v
into a String
, returning Err
if v
contains any invalid data.
Examples
Basic usage:
Heap::transaction(|j| { // 𝄞music let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063]; assert_eq!(String::pfrom("𝄞music", j), String::from_utf16(v, j).unwrap()); // 𝄞mu<invalid>ic let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0xD800, 0x0069, 0x0063]; assert!(String::from_utf16(v, j).is_err()); }).unwrap();
Decode a UTF-16 encoded slice v
into a String
, replacing
invalid data with the replacement character (U+FFFD
).
Unlike from_utf8_lossy
which returns a Cow<'a, str>
,
from_utf16_lossy
returns a String
since the UTF-16 to UTF-8
conversion requires a memory allocation.
Examples
Basic usage:
Heap::transaction(|j| { // 𝄞mus<invalid>ic<invalid> let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0xDD1E, 0x0069, 0x0063, 0xD834]; assert_eq!(String::pfrom("𝄞mus\u{FFFD}ic\u{FFFD}", j), String::from_utf16_lossy(v, j)); }).unwrap();
Converts a vector of bytes to a String
without checking that the
string contains valid UTF-8.
See the safe version, from_utf8
, for more details.
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 with future users of the String
, as the rest of
the standard library assumes that String
s are valid UTF-8.
Examples
Basic usage:
Heap::transaction(|j| { // some bytes, in a vector let sparkle_heart = vec![240, 159, 146, 150]; let sparkle_heart = unsafe { String::from_utf8_unchecked(sparkle_heart, j) }; assert_eq!("💖", sparkle_heart); }).unwrap();
Converts a String
into a byte vector.
This consumes the String
, so we do not need to copy its contents.
Examples
Basic usage:
Heap::transaction(|j| { let s = String::<Heap>::pfrom("hello", j); let bytes = s.into_bytes(); assert_eq!(&[104, 101, 108, 108, 111][..], &bytes[..]); }).unwrap();
Extracts a string slice containing the entire String
.
Examples
Basic usage:
Heap::transaction(|j| { let s = String::<Heap>::pfrom("foo", j); assert_eq!("foo", s.as_str()); }).unwrap();
Appends a given string slice onto the end of this String
.
Examples
Basic usage:
corundum::transaction(|j| { let mut s = String::<Heap>::pfrom("foo", j); s.push_str("bar", j); assert_eq!("foobar", s); }).unwrap();
Returns this String
’s capacity, in bytes.
Examples
Basic usage:
Heap::transaction(|j| { let s = String::with_capacity(10, j); assert!(s.capacity() >= 10); }).unwrap();
Ensures that this String
’s capacity is at least additional
bytes
larger than its length.
The capacity may be increased by more than additional
bytes if it
chooses, to prevent frequent reallocations.
If you do not want this “at least” behavior, see the reserve_exact
method.
Panics
Panics if the new capacity overflows usize
.
Examples
Basic usage:
Heap::transaction(|j| { let mut s = PString::new(); s.reserve(10, j); assert!(s.capacity() >= 10); }).unwrap();
This may not actually increase the capacity:
Heap::transaction(|j| { let mut s = String::with_capacity(10, j); s.push('a', j); s.push('b', j); // s now has a length of 2 and a capacity of 10 assert_eq!(2, s.len(), "a"); assert_eq!(10, s.capacity(), "b"); // Since we already have an extra 8 capacity, calling this... s.reserve(8, j); // ... doesn't actually increase. assert_eq!(10, s.capacity(), "c"); }).unwrap();
Shrinks the capacity of this String
to match its length.
Examples
Basic usage:
corundum::transaction(|j| { let mut s = String::<Heap>::pfrom("foo", j); s.reserve(100, j); assert!(s.capacity() >= 100); s.shrink_to_fit(j); assert_eq!(3, s.capacity()); }).unwrap();
Shrinks the capacity of this String
with a lower bound.
The capacity will remain at least as large as both the length and the supplied value.
Panics if the current capacity is smaller than the supplied minimum capacity.
Examples
Heap::transaction(|j| { let mut s = String::<Heap>::pfrom("foo", j); s.reserve(100, j); assert!(s.capacity() >= 100); s.shrink_to(10, j); assert!(s.capacity() >= 10); s.shrink_to(0, j); assert!(s.capacity() >= 3); }).unwrap();
Shortens this String
to the specified length.
If new_len
is greater than the string’s current length, this has no
effect.
Note that this method has no effect on the allocated capacity of the string
Panics
Panics if new_len
does not lie on a char
boundary.
Examples
Basic usage:
Heap::transaction(|j| { let mut s = String::<Heap>::pfrom("hello", j); s.truncate(2); assert_eq!("he", s); }).unwrap();
Removes a char
from this String
at a byte position and returns it.
This is an O(n)
operation, as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than or equal to the String
’s length,
or if it does not lie on a char
boundary.
Examples
Basic usage:
let mut s = String::pfrom("foo", j); assert_eq!(s.remove(0), 'f'); assert_eq!(s.remove(1), 'o'); assert_eq!(s.remove(0), 'o');
Retains only the characters specified by the predicate.
In other words, remove all characters c
such that f(c)
returns false
.
This method operates in place, visiting each character exactly once in the
original order, and preserves the order of the retained characters.
Examples
let mut s = String::pfrom("f_o_ob_ar", j); s.retain(|c| c != '_'); assert_eq!(s, "foobar");
The exact order may be useful for tracking external state, like an index.
let mut s = String::pfrom("abcde", j); let keep = [false, true, true, false, true]; let mut i = 0; s.retain(|_| (keep[i], i += 1).0); assert_eq!(s, "bce");
Inserts a character into this String
at a byte position.
This is an O(n)
operation as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than the String
’s length, or if it does not
lie on a char
boundary.
Examples
Basic usage:
let mut s = String::with_capacity(3); s.insert(0, 'f'); s.insert(1, 'o'); s.insert(2, 'o'); assert_eq!("foo", s);
Inserts a string slice into this String
at a byte position.
This is an O(n)
operation as it requires copying every element in the
buffer.
Panics
Panics if idx
is larger than the String
’s length, or if it does not
lie on a char
boundary.
Examples
Basic usage:
let mut s = String::pfrom("bar", j); s.insert_str(0, "foo", j); assert_eq!("foobar", s);
Returns the length of this String
, in bytes, not char
s or
graphemes. In other words, it may not be what a human considers the
length of the string.
Examples
Basic usage:
let a = String::pfrom("foo", j); assert_eq!(a.len(), 3); let fancy_f = String::pfrom("ƒoo", j); assert_eq!(fancy_f.len(), 4); assert_eq!(fancy_f.chars().count(), 3);
Returns true
if this String
has a length of zero, and false
otherwise.
Examples
Basic usage:
let mut v = String::new(); assert!(v.is_empty()); v.push('a'); assert!(!v.is_empty());
Splits the string into two at the given index.
Returns a newly allocated String
. self
contains bytes [0, at)
, and
the returned String
contains bytes [at, len)
. at
must be on the
boundary of a UTF-8 code point.
Note that the capacity of self
does not change.
Panics
Panics if at
is not on a UTF-8
code point boundary, or if it is beyond the last
code point of the string.
Examples
let mut hello = String::pfrom("Hello, World!", j); let world = hello.split_off(7, j); assert_eq!(hello, "Hello, "); assert_eq!(world, "World!");
Truncates this String
, removing all contents.
While this means the String
will have a length of zero, it does not
touch its capacity.
Examples
Basic usage:
let mut s = String::pfrom("foo", j); s.clear(); assert!(s.is_empty()); assert_eq!(0, s.len()); assert_eq!(3, s.capacity());
pub fn replace_range<R>(&mut self, range: R, replace_with: &str, j: &Journal<A>) where
R: RangeBounds<usize>,
pub fn replace_range<R>(&mut self, range: R, replace_with: &str, j: &Journal<A>) where
R: RangeBounds<usize>,
Removes the specified range in the string, and replaces it with the given string. The given string doesn’t need to be the same length as the range.
Panics
Panics if the starting point or end point do not lie on a char
boundary, or if they’re out of bounds.
Examples
Basic usage:
let mut s = String::pfrom("α is alpha, β is beta", j); let beta_offset = s.find('β').unwrap_or(s.len()); // Replace the range up until the β from the string s.replace_range(..beta_offset, "Α is capital alpha; ", j); assert_eq!(s, "Α is capital alpha; β is beta");
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
A convenience impl that delegates to the impl for &str
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Associated searcher for this pattern
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Constructs the associated searcher from
self
and the haystack
to search in. Read more
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Checks whether the pattern matches anywhere in the haystack
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Checks whether the pattern matches at the front of the haystack
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Checks whether the pattern matches at the back of the haystack
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Removes the pattern from the front of haystack, if it matches.
fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str> where
Self::Searcher: ReverseSearcher<'a>,
fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str> where
Self::Searcher: ReverseSearcher<'a>,
🔬 This is a nightly-only experimental API. (pattern
)
API not fully fleshed out and ready to be stabilized
Removes the pattern from the back of haystack, if it matches.
Writes a string slice into this writer, returning whether the write succeeded. Read more