Struct rhai::ImmutableString

pub struct ImmutableString(_);

The system immutable string type.

An ImmutableString wraps an Rc<String> (or Arc<String> under the sync feature) so that it can be simply shared and not cloned.

Examples

use rhai::ImmutableString;

let s1: ImmutableString = "hello".into();

// No actual cloning of the string is involved below.
let s2 = s1.clone();
let s3 = s2.clone();

assert_eq!(s1, s2);

// Clones the underlying string (because it is already shared) and extracts it.
let mut s: String = s1.into_owned();

// Changing the clone has no impact on the previously shared version.
s.push_str(", world!");

// The old version still exists.
assert_eq!(s2, s3);
assert_eq!(s2.as_str(), "hello");

// Not equals!
assert_ne!(s2.as_str(), s.as_str());
assert_eq!(s, "hello, world!");

Implementations

impl ImmutableString

pub fn into_owned(self) -> String

Consume the ImmutableString and convert it into a String. If there are other references to the same string, a cloned copy is returned.

pub fn make_mut(&mut self) -> &mut String

Make sure that the ImmutableString is unique (i.e. no other outstanding references). Then return a mutable reference to the String.

Methods from Deref<Target = String>

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire String.

Examples

Basic usage:

let s = String::from("foo");

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

pub fn capacity(&self) -> usize

Returns this String's capacity, in bytes.

Examples

Basic usage:

let s = String::with_capacity(10);

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

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:

let s = String::from("hello");

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

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::from("foo");
assert_eq!(a.len(), 3);

let fancy_f = String::from("ƒoo");
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());

Trait Implementations

impl<'_> Add<&'_ ImmutableString> for &'_ ImmutableString

type Output = ImmutableString

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<&'_ str> for ImmutableString

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_, '_> Add<&'_ str> for &'_ ImmutableString

type Output = ImmutableString

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<ImmutableString> for ImmutableString

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<String> for ImmutableString

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<String> for &'_ ImmutableString

type Output = ImmutableString

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<char> for ImmutableString

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> Add<char> for &'_ ImmutableString

type Output = ImmutableString

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'_> AddAssign<&'_ ImmutableString> for ImmutableString

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

Performs the += operation.

impl<'_> AddAssign<&'_ str> for ImmutableString

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

Performs the += operation.

impl AddAssign<ImmutableString> for ImmutableString

fn add_assign(&mut self, rhs: ImmutableString)

Performs the += operation.

impl AddAssign<char> for ImmutableString

fn add_assign(&mut self, rhs: char)

Performs the += operation.

impl AsRef<String> for ImmutableString

fn as_ref(&self) -> &String

Performs the conversion.

impl Borrow<String> for ImmutableString

fn borrow(&self) -> &String

Immutably borrows from an owned value.

impl Borrow<str> for ImmutableString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for ImmutableString

fn clone(&self) -> ImmutableString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImmutableString

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

Formats the value using the given formatter.

impl Default for ImmutableString

fn default() -> ImmutableString

Returns the "default value" for a type.

impl Deref for ImmutableString

type Target = String

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ImmutableString

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

Formats the value using the given formatter.

impl Eq for ImmutableString

impl<'_> From<&'_ str> for ImmutableString

fn from(value: &str) -> Self

Performs the conversion.

impl From<Box<String>> for ImmutableString

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

Performs the conversion.

impl From<ImmutableString> for String

fn from(value: ImmutableString) -> Self

Performs the conversion.

impl From<String> for ImmutableString

fn from(value: String) -> Self

Performs the conversion.

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

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

Creates a value from an iterator.

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

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

Creates a value from an iterator.

impl<'a> FromIterator<String> for ImmutableString

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

Creates a value from an iterator.

impl FromIterator<char> for ImmutableString

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

Creates a value from an iterator.

impl FromStr for ImmutableString

type Err = ()

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 Hash for ImmutableString

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 Ord for ImmutableString

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<ImmutableString> for ImmutableString

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

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

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

This method tests for !=.

impl PartialEq<ImmutableString> for str

fn eq(&self, other: &ImmutableString) -> 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 PartialEq<ImmutableString> for String

fn eq(&self, other: &ImmutableString) -> 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<S: AsRef<str>> PartialEq<S> for ImmutableString

fn eq(&self, other: &S) -> 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 PartialOrd<ImmutableString> for ImmutableString

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

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

fn lt(&self, other: &ImmutableString) -> bool

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

fn le(&self, other: &ImmutableString) -> bool

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

fn gt(&self, other: &ImmutableString) -> bool

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

fn ge(&self, other: &ImmutableString) -> bool

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

impl PartialOrd<ImmutableString> for str

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<ImmutableString> for String

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

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

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

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

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

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

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

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

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

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

impl<S: AsRef<str>> PartialOrd<S> for ImmutableString

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ImmutableString

impl StructuralPartialEq for ImmutableString

impl TryFrom<ImmutableString> for FnPtr

type Error = Box<EvalAltResult>

The type returned in the event of a conversion error.

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

Performs the conversion.