Struct sixtyfps_corelib::string::SharedString

#[repr(C)]pub struct SharedString { /* fields omitted */ }

A string type used by the SixtyFPS run-time.

SharedString uses implicit data sharing to make it efficient to pass around copies. When cloning, a reference to the data is cloned, not the data itself. The data itself is only copied when modifying it, for example using push_str. This is also called copy-on-write.

Under the hood the string data is UTF-8 encoded and it is always terminated with a null character.

Implementations

impl SharedString

pub fn len(&self) -> usize

Size of the string, in bytes. This excludes the terminating null character.

pub fn as_str(&self) -> &str

Return a slice to the string

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

Append a string to this string

let mut hello = SharedString::from("Hello");
hello.push_str(", ");
hello.push_str("World");
hello.push_str("!");
assert_eq!(hello, "Hello, World!");

Trait Implementations

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

type Output = SharedString

The resulting type after applying the + operator.

pub fn add(self, other: &str) -> SharedString

Performs the + operation.

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

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

Performs the += operation.

impl AsRef<[u8]> for SharedString

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

Performs the conversion.

impl AsRef<CStr> for SharedString

pub fn as_ref(&self) -> &CStr

Performs the conversion.

impl AsRef<str> for SharedString

pub fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for SharedString

pub fn clone(&self) -> SharedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedString

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

Formats the value using the given formatter.

impl Default for SharedString

pub fn default() -> Self

Returns the "default value" for a type.

impl Deref for SharedString

type Target = str

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for SharedString

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

Formats the value using the given formatter.

impl Eq for SharedString

impl<'_> From<&'_ String> for SharedString

pub fn from(s: &String) -> Self

Performs the conversion.

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

pub fn from(value: &str) -> Self

Performs the conversion.

impl From<String> for SharedString

pub fn from(s: String) -> Self

Performs the conversion.

impl Hash for SharedString

pub fn hash<H: Hasher>(&self, state: &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 Into<String> for SharedString

pub fn into(self) -> String

Performs the conversion.

impl Ord for SharedString

pub fn cmp(&self, other: &Self) -> 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<T: ?Sized> PartialEq<T> for SharedString where
    T: AsRef<str>, 

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

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

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

This method tests for !=.

impl<T: ?Sized> PartialOrd<T> for SharedString where
    T: AsRef<str>, 

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

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

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

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

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

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