Struct smol_str::SmolStr

[+] Show declaration

pub struct SmolStr(_);

[−] Expand description

A SmolStr is a string type that has the following properties:

• size_of::<SmolStr>() == size_of::<String>()
• Clone is O(1)
• Strings are stack-allocated if they are:
  • Up to 22 bytes long
  • Longer than 22 bytes, but substrings of WS (see below). Such strings consist solely of consecutive newlines, followed by consecutive spaces
• If a string does not satisfy the aforementioned conditions, it is heap-allocated

Unlike String, however, SmolStr is immutable. The primary use case for SmolStr is a good enough default storage for tokens of typical programming languages. Strings consisting of a series of newlines, followed by a series of whitespace are a typical pattern in computer programs because of indentation. Note that a specialized interner might be a better solution for some use cases.

Implementations

impl SmolStr[−]

pub const fn new_inline_from_ascii(len: usize, bytes: &[u8]) -> SmolStr

👎 Deprecated:

Use new_inline instead

pub const fn new_inline(text: &str) -> SmolStr[−]

Constructs inline variant of SmolStr.

Panics if text.len() > 22.

pub fn new<T>(text: T) -> SmolStr where
    T: AsRef<str>, 

pub fn as_str(&self) -> &str

pub fn to_string(&self) -> String

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_heap_allocated(&self) -> bool

Trait Implementations

impl Borrow<str> for SmolStr[+]

[+] Show hidden undocumented items

fn borrow(&self) -> &str[−]

Immutably borrows from an owned value.

impl Clone for SmolStr[+]

[+] Show hidden undocumented items

fn clone(&self) -> SmolStr[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for SmolStr[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for SmolStr[+]

[+] Show hidden undocumented items

fn default() -> SmolStr[−]

Returns the "default value" for a type.

impl Deref for SmolStr[+]

[+] Show hidden undocumented items

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str[−]

Dereferences the value.

impl Display for SmolStr[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for SmolStr

impl From<SmolStr> for String[+]

[+] Show hidden undocumented items

fn from(text: SmolStr) -> Self[−]

Performs the conversion.

impl<T> From<T> for SmolStr where
    T: Into<String> + AsRef<str>, [+]

[+] Show hidden undocumented items

fn from(text: T) -> Self[−]

Performs the conversion.

impl<'a> FromIterator<&'a String> for SmolStr[+]

[+] Show hidden undocumented items

fn from_iter<I: IntoIterator<Item = &'a String>>(iter: I) -> SmolStr[−]

Creates a value from an iterator.

impl<'a> FromIterator<&'a str> for SmolStr[+]

[+] Show hidden undocumented items

fn from_iter<I: IntoIterator<Item = &'a str>>(iter: I) -> SmolStr[−]

Creates a value from an iterator.

impl FromIterator<String> for SmolStr[+]

[+] Show hidden undocumented items

fn from_iter<I: IntoIterator<Item = String>>(iter: I) -> SmolStr[−]

Creates a value from an iterator.

impl FromIterator<char> for SmolStr[+]

[+] Show hidden undocumented items

fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> SmolStr[−]

Creates a value from an iterator.

impl Hash for SmolStr[+]

[+] Show hidden undocumented items

fn hash<H: Hasher>(&self, hasher: &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 SmolStr[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &SmolStr) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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<'a> PartialEq<&'a String> for SmolStr[+]

[+] Show hidden undocumented items

fn eq(&self, other: &&'a String) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl<'a> PartialEq<&'a str> for SmolStr[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl PartialEq<SmolStr> for SmolStr[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SmolStr) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl PartialEq<SmolStr> for str[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SmolStr) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl<'a> PartialEq<SmolStr> for &'a str[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SmolStr) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl PartialEq<SmolStr> for String[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SmolStr) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl<'a> PartialEq<SmolStr> for &'a String[+]

[+] Show hidden undocumented items

fn eq(&self, other: &SmolStr) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl PartialEq<String> for SmolStr[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl PartialEq<str> for SmolStr[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl PartialOrd<SmolStr> for SmolStr[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &SmolStr) -> Option<Ordering>[−]

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

[+] Expand attributes

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

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

[+] Expand attributes

#[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.

[+] Expand attributes

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

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

[+] Expand attributes

#[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.