Type Alias GcString

pub(crate) type GcString<'a> = String<'a>;

Aliased Type

pub(crate) struct GcString<'a> { /* private fields */ }

Implementations

impl<'bump> String<'bump>

pub fn new_in(bump: &'bump Bump) -> String<'bump>

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_in method to prevent excessive re-allocation.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::new_in(&b);

pub fn with_capacity_in(capacity: usize, bump: &'bump Bump) -> String<'bump>

Creates a new empty String with a particular capacity.

Strings 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_in method.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::with_capacity_in(10, &b);

// The String 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');
}

assert_eq!(s.capacity(), cap);

// ...but this may make the vector reallocate
s.push('a');

pub fn from_utf8( vec: Vec<'bump, u8>, ) -> Result<String<'bump>, FromUtf8Error<'bump>>

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 Strings, 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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some bytes, in a vector
let sparkle_heart = bumpalo::vec![in &b; 240, 159, 146, 150];

// We know these bytes are valid, so we'll use `unwrap()`.
let sparkle_heart = String::from_utf8(sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

Incorrect bytes:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some invalid bytes, in a vector
let sparkle_heart = bumpalo::vec![in &b; 0, 159, 146, 150];

assert!(String::from_utf8(sparkle_heart).is_err());

See the docs for FromUtf8Error for more details on what you can do with this error.

pub fn from_utf8_lossy_in(v: &[u8], bump: &'bump Bump) -> String<'bump>

Converts a slice of bytes to a 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_in() 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.

Examples

Basic usage:

use bumpalo::{collections::String, Bump, vec};

let b = Bump::new();

// some bytes, in a vector
let sparkle_heart = bumpalo::vec![in &b; 240, 159, 146, 150];

let sparkle_heart = String::from_utf8_lossy_in(&sparkle_heart, &b);

assert_eq!("💖", sparkle_heart);

Incorrect bytes:

use bumpalo::{collections::String, Bump, vec};

let b = Bump::new();

// some invalid bytes
let input = b"Hello \xF0\x90\x80World";
let output = String::from_utf8_lossy_in(input, &b);

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

pub fn from_utf16_in( v: &[u16], bump: &'bump Bump, ) -> Result<String<'bump>, FromUtf16Error>

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

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// 𝄞music
let v = &[0xD834, 0xDD1E, 0x006d, 0x0075, 0x0073, 0x0069, 0x0063];
assert_eq!(String::from_str_in("𝄞music", &b), String::from_utf16_in(v, &b).unwrap());

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

pub fn from_str_in(s: &str, bump: &'bump Bump) -> String<'bump>

Construct a new String<'bump> from a string slice.

Examples

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_str_in("hello", &b);
assert_eq!(s, "hello");

pub fn from_iter_in<I>(iter: I, bump: &'bump Bump) -> String<'bump>

where I: IntoIterator<Item = char>,

Construct a new String<'bump> from an iterator of chars.

Examples

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_iter_in(['h', 'e', 'l', 'l', 'o'].iter().cloned(), &b);
assert_eq!(s, "hello");

pub unsafe fn from_raw_parts_in( buf: *mut u8, length: usize, capacity: usize, bump: &'bump Bump, ) -> String<'bump>

Creates a new String from a length, capacity, and pointer.

Safety

This is highly unsafe, due to the number of invariants that aren’t checked:

• The memory at ptr needs to have been previously allocated by the same allocator the standard library uses.
• length needs to be less than or equal to capacity.
• capacity needs to be the correct value.

Violating these may cause problems like corrupting the allocator’s internal data structures.

The ownership of ptr is effectively transferred to the String which may then deallocate, reallocate or change the contents of memory pointed to by the pointer at will. Ensure that nothing else uses the pointer after calling this function.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};
use std::mem;

let b = Bump::new();

unsafe {
    let mut s = String::from_str_in("hello", &b);
    let ptr = s.as_mut_ptr();
    let len = s.len();
    let capacity = s.capacity();

    mem::forget(s);

    let s = String::from_raw_parts_in(ptr, len, capacity, &b);

    assert_eq!(s, "hello");
}

pub unsafe fn from_utf8_unchecked(bytes: Vec<'bump, u8>) -> String<'bump>

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 it is assumed that Strings are valid UTF-8.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some bytes, in a vector
let sparkle_heart = bumpalo::vec![in &b; 240, 159, 146, 150];

let sparkle_heart = unsafe {
    String::from_utf8_unchecked(sparkle_heart)
};

assert_eq!("💖", sparkle_heart);

pub fn bump(&self) -> &'bump Bump

Returns a shared reference to the allocator backing this String.

Examples

use bumpalo::{Bump, collections::String};

// uses the same allocator as the provided `String`
fn copy_string<'bump>(s: &String<'bump>) -> &'bump str {
    s.bump().alloc_str(s.as_str())
}

pub fn into_bytes(self) -> Vec<'bump, u8>

Converts a String into a byte vector.

This consumes the String, so we do not need to copy its contents.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_str_in("hello", &b);

assert_eq!(s.into_bytes(), [104, 101, 108, 108, 111]);

pub fn into_bump_str(self) -> &'bump str

Convert this String<'bump> into a &'bump str. This is analogous to std::string::String::into_boxed_str.

Example

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_str_in("foo", &b);

assert_eq!(s.into_bump_str(), "foo");

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_str_in("foo", &b);

assert_eq!("foo", s.as_str());

pub fn as_mut_str(&mut self) -> &mut str

Converts a String into a mutable string slice.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foobar", &b);
let s_mut_str = s.as_mut_str();

s_mut_str.make_ascii_uppercase();

assert_eq!("FOOBAR", s_mut_str);

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

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

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foo", &b);

s.push_str("bar");

assert_eq!("foobar", s);

pub fn capacity(&self) -> usize

Returns this String’s capacity, in bytes.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::with_capacity_in(10, &b);

assert!(s.capacity() >= 10);

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

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::new_in(&b);

s.reserve(10);

assert!(s.capacity() >= 10);

This may not actually increase the capacity:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::with_capacity_in(10, &b);
s.push('a');
s.push('b');

// s now has a length of 2 and a capacity of 10
assert_eq!(2, s.len());
assert_eq!(10, s.capacity());

// Since we already have an extra 8 capacity, calling this...
s.reserve(8);

// ... doesn't actually increase.
assert_eq!(10, s.capacity());

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

Ensures that this String’s capacity is additional bytes larger than its length.

Consider using the reserve method unless you absolutely know better than the allocator.

Panics

Panics if the new capacity overflows usize.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::new_in(&b);

s.reserve_exact(10);

assert!(s.capacity() >= 10);

This may not actually increase the capacity:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::with_capacity_in(10, &b);
s.push('a');
s.push('b');

// s now has a length of 2 and a capacity of 10
assert_eq!(2, s.len());
assert_eq!(10, s.capacity());

// Since we already have an extra 8 capacity, calling this...
s.reserve_exact(8);

// ... doesn't actually increase.
assert_eq!(10, s.capacity());

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of this String to match its length.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foo", &b);

s.reserve(100);
assert!(s.capacity() >= 100);

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

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

Appends the given char to the end of this String.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("abc", &b);

s.push('1');
s.push('2');
s.push('3');

assert_eq!("abc123", s);

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

Returns a byte slice of this String’s contents.

The inverse of this method is from_utf8.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let s = String::from_str_in("hello", &b);

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

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

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("hello", &b);

s.truncate(2);

assert_eq!("he", s);

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

Removes the last character from the string buffer and returns it.

Returns None if this String is empty.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foo", &b);

assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('f'));

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

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

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foo", &b);

assert_eq!(s.remove(0), 'f');
assert_eq!(s.remove(1), 'o');
assert_eq!(s.remove(0), 'o');

pub fn retain<F>(&mut self, f: F)

where F: FnMut(char) -> bool,

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 and preserves the order of the retained characters.

Examples

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("f_o_ob_ar", &b);

s.retain(|c| c != '_');

assert_eq!(s, "foobar");

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

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::with_capacity_in(3, &b);

s.insert(0, 'f');
s.insert(1, 'o');
s.insert(2, 'o');

assert_eq!("foo", s);

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

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("bar", &b);

s.insert_str(0, "foo");

assert_eq!("foobar", s);

pub unsafe fn as_mut_vec(&mut self) -> &mut Vec<'bump, u8>

Returns a mutable reference to the contents of this String.

Safety

This function is unsafe because the returned &mut Vec allows writing bytes which are not valid UTF-8. If this constraint is violated, using the original String after dropping the &mut Vec may violate memory safety, as it is assumed that Strings are valid UTF-8.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("hello", &b);

unsafe {
    let vec = s.as_mut_vec();
    assert_eq!(vec, &[104, 101, 108, 108, 111]);

    vec.reverse();
}
assert_eq!(s, "olleh");

pub fn len(&self) -> usize

Returns the length of this String, in bytes.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let a = String::from_str_in("foo", &b);

assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if this String has a length of zero.

Returns false otherwise.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut v = String::new_in(&b);
assert!(v.is_empty());

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

pub fn split_off(&mut self, at: usize) -> String<'bump>

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

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut hello = String::from_str_in("Hello, World!", &b);
let world = hello.split_off(7);
assert_eq!(hello, "Hello, ");
assert_eq!(world, "World!");

pub fn clear(&mut self)

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("foo", &b);

s.clear();

assert!(s.is_empty());
assert_eq!(0, s.len());
assert_eq!(3, s.capacity());

pub fn drain<'a, R>(&'a mut self, range: R) -> Drain<'a, 'bump>

where R: RangeBounds<usize>,

Creates a draining iterator that removes the specified range in the String and yields the removed chars.

Note: The element range is removed even if the iterator is not consumed until the end.

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("α is alpha, β is beta", &b);
let beta_offset = s.find('β').unwrap_or(s.len());

// Remove the range up until the β from the string
let t = String::from_iter_in(s.drain(..beta_offset), &b);
assert_eq!(t, "α is alpha, ");
assert_eq!(s, "β is beta");

// A full range clears the string
drop(s.drain(..));
assert_eq!(s, "");

pub fn replace_range<R>(&mut self, range: R, replace_with: &str)

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:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

let mut s = String::from_str_in("α is alpha, β is beta", &b);
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; ");
assert_eq!(s, "Α is capital alpha; β is beta");

Trait Implementations

impl<'a, 'bump> Add<&'a str> for String<'bump>

Implements the + operator for concatenating two strings.

This consumes the String<'bump> on the left-hand side and re-uses its buffer (growing it if necessary). This is done to avoid allocating a new String<'bump> and copying the entire contents on every operation, which would lead to O(n^2) running time when building an n-byte string by repeated concatenation.

The string on the right-hand side is only borrowed; its contents are copied into the returned String<'bump>.

Examples

Concatenating two String<'bump>s takes the first by value and borrows the second:

use bumpalo::{Bump, collections::String};

let bump = Bump::new();

let a = String::from_str_in("hello", &bump);
let b = String::from_str_in(" world", &bump);
let c = a + &b;
// `a` is moved and can no longer be used here.

If you want to keep using the first String, you can clone it and append to the clone instead:

use bumpalo::{Bump, collections::String};

let bump = Bump::new();

let a = String::from_str_in("hello", &bump);
let b = String::from_str_in(" world", &bump);
let c = a.clone() + &b;
// `a` is still valid here.

Concatenating &str slices can be done by converting the first to a String:

use bumpalo::{Bump, collections::String};

let bump = Bump::new();

let a = "hello";
let b = " world";
let c = String::from_str_in(a, &bump) + b;

type Output = String<'bump>

The resulting type after applying the + operator.

fn add(self, other: &str) -> String<'bump>

Performs the + operation.

impl<'a, 'bump> AddAssign<&'a str> for String<'bump>

Implements the += operator for appending to a String<'bump>.

This has the same behavior as the [push_str][String::push_str] method.

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

Performs the += operation.

impl<'bump> AsRef<[u8]> for String<'bump>

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

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

impl<'bump> AsRef<str> for String<'bump>

fn as_ref(&self) -> &str

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

impl<'bump> Borrow<str> for String<'bump>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<'bump> BorrowMut<str> for String<'bump>

fn borrow_mut(&mut self) -> &mut str

Mutably borrows from an owned value.

impl<'bump> Clone for String<'bump>

fn clone(&self) -> String<'bump>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &String<'bump>)

Performs copy-assignment from source.

impl<'bump> Debug for String<'bump>

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

Formats the value using the given formatter.

impl<'bump> Deref for String<'bump>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<'bump> DerefMut for String<'bump>

fn deref_mut(&mut self) -> &mut str

Mutably dereferences the value.

impl<'bump> Display for String<'bump>

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

Formats the value using the given formatter.

impl<'a, 'bump> Extend<&'a char> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a char>,

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, 'bump> Extend<&'a str> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = &'a str>,

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, 'bump> Extend<Cow<'a, str>> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = Cow<'a, str>>,

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<'bump> Extend<String<'bump>> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = String<'bump>>,

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<'bump> Extend<String> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = String>,

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<'bump> Extend<char> for String<'bump>

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = char>,

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<'bump> FromIteratorIn<char> for String<'bump>

type Alloc = &'bump Bump

The allocator type

fn from_iter_in<I>( iter: I, alloc: <String<'bump> as FromIteratorIn<char>>::Alloc, ) -> String<'bump>

where I: IntoIterator<Item = char>,

Similar to FromIterator::from_iter, but with a given allocator.

impl<'bump> Hash for String<'bump>

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

where H: Hasher,

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<'bump> Index<Range<usize>> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> Index<RangeFrom<usize>> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> Index<RangeFull> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> Index<RangeInclusive<usize>> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> Index<RangeTo<usize>> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> Index<RangeToInclusive<usize>> for String<'bump>

type Output = str

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &str

Performs the indexing (container[index]) operation.

impl<'bump> IndexMut<Range<usize>> for String<'bump>

fn index_mut(&mut self, index: Range<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'bump> IndexMut<RangeFrom<usize>> for String<'bump>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'bump> IndexMut<RangeFull> for String<'bump>

fn index_mut(&mut self, _index: RangeFull) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'bump> IndexMut<RangeInclusive<usize>> for String<'bump>

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'bump> IndexMut<RangeTo<usize>> for String<'bump>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl<'bump> IndexMut<RangeToInclusive<usize>> for String<'bump>

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IntoObject for String<'_>

type Out<'ob> = <String as IntoObject>::Out<'ob>

fn into_obj<const C: bool>(self, block: &Block<C>) -> Gc<Self::Out<'_>>

impl<'bump> Ord for String<'bump>

fn cmp(&self, other: &String<'bump>) -> 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<'a, 'bump> PartialEq<&'a str> for String<'bump>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b, 'bump> PartialEq<Cow<'a, str>> for String<'bump>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b, 'bump> PartialEq<String> for String<'bump>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'bump> PartialEq<str> for String<'bump>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'bump> PartialEq for String<'bump>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'bump> PartialOrd for String<'bump>

fn partial_cmp(&self, other: &String<'bump>) -> 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<'bump> Write for String<'bump>

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<'bump> Eq for String<'bump>