Struct SmallString 

pub struct SmallString { /* private fields */ }

Implementations

impl SmallString

pub const EMPTY: SmallString

pub const fn len(&self) -> usize

pub const fn is_ascii(&self) -> bool

Returns true if the SmallString contains only ASCII characters.

Example

use small_string::SmallString;
assert!(SmallString::try_from("abc").unwrap().is_ascii());
assert!(!SmallString::try_from("📦").unwrap().is_ascii());

pub fn utf16_len(&self) -> usize

pub fn char_code_at(&self, idx: usize) -> CodePoint

pub fn code_point_at(self, idx: usize) -> CodePoint

Get the CodePoint at a given WTF-16 index.

pub fn utf8_index(&self, utf16_idx: usize) -> Option<usize>

pub fn utf16_index(&self, utf8_idx: usize) -> usize

pub fn to_string_lossy(&self) -> Cow<'_, str>

Lossily convert the string to UTF-8. Return an UTF-8 &str slice if the contents are well-formed in UTF-8.

Surrogates are replaced with "\u{FFFD}" (the replacement character “�”).

This only copies the data if necessary (if it contains any surrogate).

pub fn as_str(&self) -> Option<&str>

Try to convert the string to UTF-8 and return a &str slice.

Return None if the string contains surrogates.

This does not copy the data.

pub const unsafe fn as_str_unchecked(&self) -> &str

Get the SmallString data as a string slice without checking that the SmallString contains valid UTF-8.

Safety

The SmallString must contain valid UTF-8.

pub const fn as_wtf8(&self) -> &Wtf8

pub const fn as_bytes(&self) -> &[u8]

pub const fn data(&self) -> &[u8; 7]

pub const fn data_mut(&mut self) -> &mut [u8; 7]

pub const fn is_empty(&self) -> bool

pub const unsafe fn from_str_unchecked(string: &str) -> SmallString

Create a SmallString from a str without checking that it is small enough to fit in the inline buffer.

Safety

Caller must ensure that string 7 bytes or fewer long.

pub fn from_wtf8(string: &Wtf8) -> SmallString

Inline a Wtf8 into a SmallString.

Panics

If string is longer than 7 bytes.

pub const unsafe fn from_wtf8_unchecked(string: &Wtf8) -> SmallString

Create a SmallString from a Wtf8 without checking that it is small enough to fit in the inline buffer.

Safety

Caller must ensure that string 7 bytes or fewer long.

pub fn from_char(ch: char) -> SmallString

pub fn from_code_point(ch: CodePoint) -> SmallString

Trait Implementations

impl Clone for SmallString

fn clone(&self) -> SmallString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SmallString

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

Formats the value using the given formatter.

impl From<SmallString> for Primitive<'static>

fn from(value: SmallString) -> Self

Converts to this type from the input type.

impl From<SmallString> for String<'static>

fn from(value: SmallString) -> Self

Converts to this type from the input type.

impl From<SmallString> for Value<'static>

fn from(value: SmallString) -> Self

Converts to this type from the input type.

impl From<char> for SmallString

fn from(ch: char) -> SmallString

Converts to this type from the input type.

impl Hash for SmallString

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SmallString

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for SmallString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for SmallString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for SmallString

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SmallString

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&Wtf8> for SmallString

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: &Wtf8, ) -> Result<SmallString, <SmallString as TryFrom<&Wtf8>>::Error>

Performs the conversion.

impl TryFrom<&str> for SmallString

type Error = ()

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<SmallString, <SmallString as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for SmallString

impl Eq for SmallString

impl StructuralPartialEq for SmallString