Struct string::String

pub struct String<T = Vec<u8>> { /* fields omitted */ }

A UTF-8 encoded string with configurable byte storage.

This type differs from std::String in that it is generic over the underlying byte storage, enabling it to use Vec<[u8]>, &[u8], or third party types, such as Bytes.

In order to construct String via any of the non-unsafe constructors, the backing storage needs to implement the StableAsRef marker trait. If you wish to construct String with a type that does not implement StableAsRef, you can use the from_utf8_unchecked constructor.

Methods

impl<T> String<T>

pub fn get_ref(&self) -> &T

Get a reference to the underlying byte storage.

Examples

let s = String::new();
let vec = s.get_ref();

pub unsafe fn get_mut(&mut self) -> &mut T

Get a mutable reference to the underlying byte storage.

It is inadvisable to directly manipulate the byte storage. This function is unsafe as the bytes could no longer be valid UTF-8 after mutation.

Examples

let mut s = String::new();

unsafe {
    let vec = s.get_mut();
}

pub fn into_inner(self) -> T

Unwraps this String, returning the underlying byte storage.

Examples

let s = String::new();
let vec = s.into_inner();

pub fn from_str<'a>(src: &'a str) -> String<T> where
    T: From<&'a [u8]> + StableAsRef, 

Creates a new String from a &str.

Use TryFrom for conversion from &u8.

let _: String<Vec<u8>> = String::from_str("nice str");

impl String

pub fn new() -> String

Creates a new empty String.

Given that the String is empty, this will not allocate.

Examples

Basic usage

let s = String::new();
assert_eq!(s, "");

impl<T> String<T> where
    T: AsRef<[u8]>, 

pub unsafe fn from_utf8_unchecked(value: T) -> String<T>

Converts the provided value to a String without checking that the given value is valid UTF-8.

Use TryFrom for a safe conversion.

Safety

You must ensure that:

1. The backing storage type T adheres to the contract as documented on the StableAsRef marker trait.
2. If T implements AsRef<[u8]> and/or AsMut<[u8]>, the byte slice returned by calling as_ref and/or as_mut on the provided value represents valid utf-8.

Trait Implementations

impl<T> TryFrom<T> for String<T> where
    T: AsRef<[u8]> + StableAsRef, 

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(value: T) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: PartialOrd> PartialOrd<String<T>> for String<T>

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

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

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

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

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

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

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

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

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

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

impl<T: PartialEq> PartialEq<String<T>> for String<T>

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

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

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

This method tests for !=.

impl<T> PartialEq<str> for String<T> where
    T: AsRef<[u8]>, 

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: Ord> Ord for String<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<T> Default for String<T> where
    T: Default + StableAsRef, 

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone> Clone for String<T>

fn clone(&self) -> String<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<String> for String<String>

fn from(value: String) -> Self

Performs the conversion.

impl<T: Eq> Eq for String<T>

impl<T> DerefMut for String<T> where
    T: AsRef<[u8]> + AsMut<[u8]>, 

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

Mutably dereferences the value.

impl<T> Hash for String<T> where
    T: AsRef<[u8]>, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<T> Deref for String<T> where
    T: AsRef<[u8]>, 

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl<T: AsRef<[u8]>> Display for String<T>

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

Formats the value using the given formatter.

impl<T: AsRef<[u8]>> Debug for String<T>

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

Formats the value using the given formatter.

impl<T> Borrow<str> for String<T> where
    T: AsRef<[u8]>, 

fn borrow(&self) -> &str

Immutably borrows from an owned value.