Struct crndm::str::String

pub struct String<A: MemPool> { /* fields omitted */ }

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

Strings 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

Strings 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

impl<A: MemPool> String<A>

pub const fn new(j: &Journal<A>) -> String<A>

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 = String::<Heap>::new(j);
}).unwrap();

pub fn with_capacity(capacity: usize, j: &Journal<A>) -> String<A>

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 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();

pub fn from_str(s: &str, j: &Journal<A>) -> String<A>

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();

pub fn from_utf8(
    vec: StdVec<u8>,
    j: &Journal<A>
) -> Result<String<A>, FromUtf8Error>

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:

// 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.

pub fn from_utf8_lossy<'a>(v: &'a [u8], j: &Journal<A>) -> String<A>

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();

pub fn from_utf16(v: &[u16], j: &Journal<A>) -> Result<String<A>, &'static str>

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();

pub fn from_utf16_lossy(v: &[u16], j: &Journal<A>) -> String<A>

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();

pub unsafe fn from_utf8_unchecked(
    bytes: StdVec<u8>,
    journal: &Journal<A>
) -> String<A>

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 Strings 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();

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

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();

pub fn as_str(&self) -> &str

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();

pub fn push_str(&mut self, string: &str, j: &Journal<A>)

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

Examples

Basic usage:

crndm::transaction(|j| {
    let mut s = String::<Heap>::pfrom("foo", j);

    s.push_str("bar", j);

    assert_eq!("foobar", s);
}).unwrap();

pub fn capacity(&self) -> usize

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();

pub fn reserve(&mut self, additional: usize, j: &Journal<A>)

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 = String::<Heap>::new(j);

    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());
    assert_eq!(10, s.capacity());

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

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

pub fn shrink_to_fit(&mut self, j: &Journal<A>)

Shrinks the capacity of this String to match its length.

Examples

Basic usage:

crndm::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();

pub fn shrink_to(&mut self, min_capacity: usize, j: &Journal<A>)

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();

pub fn push(&mut self, ch: char, j: &Journal<A>)

Appends the given char to the end of this String.

Examples

Basic usage:

let mut s = String::pfrom("abc", j);

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

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:

Heap::transaction(|j| {
    let s = String::<Heap>::pfrom("hello", j);
    assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());
}).unwrap();

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:

Heap::transaction(|j| {
    let mut s = String::<Heap>::pfrom("hello", j);

    s.truncate(2);

    assert_eq!("he", s);
}).unwrap();

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:

let mut s = String::pfrom("foo", j);

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:

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');

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, 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");

pub fn insert(&mut self, idx: usize, ch: char, j: &Journal<A>)

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);

pub fn insert_str(&mut self, idx: usize, string: &str, j: &Journal<A>)

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);

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

Returns a mutable reference to the contents of this String.

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 Strings are valid UTF-8.

Examples

Basic usage:

let mut s = String::pfrom("hello", j);

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

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

pub fn len(&self) -> usize

Returns the length of this String, in bytes, not chars 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);

pub fn is_empty(&self) -> bool

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());

pub fn split_off(&mut self, at: usize, j: &Journal<A>) -> String<A>

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!");

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:

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

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

impl<A: MemPool> AsMut<str> for String<A>

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

Performs the conversion.

impl<A: MemPool> AsRef<[u8]> for String<A>

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

Performs the conversion.

impl<A: MemPool> AsRef<str> for String<A>

pub fn as_ref(&self) -> &str

Performs the conversion.

impl<A: MemPool> Debug for String<A>

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

Formats the value using the given formatter.

impl<A: MemPool> Default for String<A>

pub fn default() -> String<A>

Creates an empty String.

impl<A: MemPool> Deref for String<A>

type Target = str

The resulting type after dereferencing.

pub fn deref(&self) -> &str

Dereferences the value.

impl<A: MemPool> DerefMut for String<A>

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

Mutably dereferences the value.

impl<A: MemPool> Display for String<A>

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

Formats the value using the given formatter.

impl<A: Eq + MemPool> Eq for String<A>

impl<'a, A: MemPool> From<&'a String<A>> for Cow<'a, str>

pub fn from(s: &'a String<A>) -> Cow<'a, str>

Performs the conversion.

impl<A: MemPool> From<String<A>> for Vec<u8, A>

pub fn from(string: String<A>) -> Vec<u8, A>

Converts the given String to a vector Vec that holds values of type u8.

Examples

Basic usage:

Heap::transaction(|j| {
    let s1 = String::<Heap>::pfrom("hello world", j);
    let v1 = Vec::from(s1);

    for b in v1.as_slice() {
        println!("{}", b);
    }
}).unwrap();

impl<A: MemPool> Hash for String<A>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<A: MemPool> Index<Range<usize>> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> Index<RangeFrom<usize>> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> Index<RangeFull> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> Index<RangeInclusive<usize>> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> Index<RangeTo<usize>> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> Index<RangeToInclusive<usize>> for String<A>

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<A: MemPool> IndexMut<Range<usize>> for String<A>

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

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

impl<A: MemPool> IndexMut<RangeFrom<usize>> for String<A>

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

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

impl<A: MemPool> IndexMut<RangeFull> for String<A>

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

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

impl<A: MemPool> IndexMut<RangeInclusive<usize>> for String<A>

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

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

impl<A: MemPool> IndexMut<RangeTo<usize>> for String<A>

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

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

impl<A: MemPool> IndexMut<RangeToInclusive<usize>> for String<A>

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

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

impl<A: Ord + MemPool> Ord for String<A>

pub fn cmp(&self, other: &String<A>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<A: MemPool> PClone<A> for String<A>

pub fn pclone(&self, journal: &Journal<A>) -> Self

pub fn pclone_from(&mut self, source: &Self, journal: &Journal<A>)

Performs copy-assignment from source.

impl<A: MemPool, '_> PFrom<&'_ str, A> for String<A>

pub fn pfrom(s: &str, j: &Journal<A>) -> String<A>

impl<'a, 'b, A: MemPool> PartialEq<&'a str> for String<A>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<A: MemPool> PartialEq<String<A>> for String<A>

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &String<A>) -> bool

This method tests for !=.

impl<'a, 'b, A: MemPool> PartialEq<String<A>> for str

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &String<A>) -> bool

This method tests for !=.

impl<'a, 'b, A: MemPool> PartialEq<String<A>> for &'a str

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &String<A>) -> bool

This method tests for !=.

impl<'a, 'b, A: MemPool> PartialEq<str> for String<A>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<A: PartialOrd + MemPool> PartialOrd<String<A>> for String<A>

pub fn partial_cmp(&self, other: &String<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &String<A>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &String<A>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &String<A>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &String<A>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, 'b, A: MemPool> Pattern<'a> for &'b String<A>

A convenience impl that delegates to the impl for &str

type Searcher = <&'b str as Pattern<'a>>::Searcher

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

API not fully fleshed out and ready to be stabilized

Associated searcher for this pattern

pub fn into_searcher(
    self,
    haystack: &'a str
) -> <&'b str as Pattern<'a>>::Searcher

🔬 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.

pub fn is_contained_in(self, haystack: &'a str) -> bool

🔬 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

pub fn is_prefix_of(self, haystack: &'a str) -> bool

🔬 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

pub fn is_suffix_of(self, haystack: &'a str) -> bool where
    Self::Searcher: ReverseSearcher<'a>, 

🔬 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

pub fn strip_prefix_of(self, haystack: &'a str) -> Option<&'a str>

🔬 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.

pub 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.

impl<A: MemPool> RootObj<A> for String<A>

pub fn init(j: &Journal<A>) -> Self

impl<A: MemPool> StructuralEq for String<A>

impl<A: MemPool> ToString for String<A>

pub fn to_string(&self) -> StdString

Converts the given value to a String.

impl<A: MemPool> Write for String<A>

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

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

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

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

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

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