Enum inlinable_string::InlinableString

pub enum InlinableString {
    Heap(String),
    Inline(InlineString),
}

An owned, grow-able UTF-8 string that allocates short strings inline on the stack.

See the module level documentation for more.

Variants

Heap(String)

A heap-allocated string.

Inline(InlineString)

A small string stored inline.

Trait Implementations

impl<'a> Add<&'a str> for InlinableString

type Output = InlinableString

The resulting type after applying the + operator.

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

Performs the + operation.

impl AsMut<str> for InlinableString

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

Performs the conversion.

impl AsRef<str> for InlinableString

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for InlinableString

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for InlinableString

fn clone(&self) -> InlinableString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InlinableString

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

Formats the value using the given formatter.

impl Default for InlinableString

fn default() -> Self

Returns the "default value" for a type.

impl Deref for InlinableString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl DerefMut for InlinableString

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

Mutably dereferences the value.

impl Display for InlinableString

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

Formats the value using the given formatter.

impl Eq for InlinableString

impl<'a> Extend<&'a char> for InlinableString

fn extend<I: IntoIterator<Item = &'a char>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> Extend<&'a str> for InlinableString

fn extend<I: IntoIterator<Item = &'a str>>(&mut self, iterable: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<char> for InlinableString

fn extend<I: IntoIterator<Item = char>>(&mut self, iterable: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'a> From<&'a str> for InlinableString

fn from(string: &'a str) -> InlinableString

Performs the conversion.

impl From<String> for InlinableString

fn from(string: String) -> InlinableString

Performs the conversion.

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

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

Creates a value from an iterator.

impl FromIterator<char> for InlinableString

fn from_iter<I: IntoIterator<Item = char>>(iter: I) -> InlinableString

Creates a value from an iterator.

impl Hash for InlinableString

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 Index<Range<usize>> for InlinableString

type Output = str

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &str

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for InlinableString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &str

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for InlinableString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeFull) -> &str

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for InlinableString

type Output = str

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &str

Performs the indexing (container[index]) operation.

impl IndexMut<Range<usize>> for InlinableString

fn index_mut(&mut self, index: Range<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFrom<usize>> for InlinableString

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFull> for InlinableString

fn index_mut(&mut self, index: RangeFull) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeTo<usize>> for InlinableString

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl Ord for InlinableString

fn cmp(&self, rhs: &InlinableString) -> 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<'a> PartialEq<&'a str> for InlinableString

fn eq(&self, other: &&'a 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<'a> PartialEq<Cow<'a, str>> for InlinableString

fn eq(&self, other: &Cow<'a, 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 PartialEq<InlinableString> for InlinableString

fn eq(&self, rhs: &InlinableString) -> 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<'a> PartialEq<InlinableString> for str

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

fn eq(&self, other: &InlinableString) -> 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<'a> PartialEq<InlinableString> for &'a str

fn eq(&self, other: &InlinableString) -> 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<'a> PartialEq<InlinableString> for InlineString

fn eq(&self, other: &InlinableString) -> 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<'a> PartialEq<InlinableString> for Cow<'a, str>

fn eq(&self, other: &InlinableString) -> 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<'a> PartialEq<InlineString> for InlinableString

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

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

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 PartialOrd<InlinableString> for InlinableString

fn partial_cmp(&self, rhs: &InlinableString) -> 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<'a> StringExt<'a> for InlinableString

fn new() -> Self

Creates a new string buffer initialized with the empty string.

fn with_capacity(capacity: usize) -> Self

Creates a new string buffer with the given capacity. The string will be able to hold at least capacity bytes without reallocating. If capacity is less than or equal to INLINE_STRING_CAPACITY, the string will not heap allocate.

fn from_utf8(vec: Vec<u8>) -> Result<Self, FromUtf8Error>

Returns the vector as a string buffer, if possible, taking care not to copy it.

fn from_utf16(v: &[u16]) -> Result<Self, FromUtf16Error>

Decode a UTF-16 encoded vector v into a InlinableString, returning None if v contains any invalid data.

fn from_utf16_lossy(v: &[u16]) -> Self

Decode a UTF-16 encoded vector v into a string, replacing invalid data with the replacement character (U+FFFD).

unsafe fn from_raw_parts(buf: *mut u8, length: usize, capacity: usize) -> Self

Creates a new InlinableString from a length, capacity, and pointer.

unsafe fn from_utf8_unchecked(bytes: Vec<u8>) -> Self

Converts a vector of bytes to a new InlinableString without checking if it contains valid UTF-8.

fn into_bytes(self) -> Vec<u8>

Returns the underlying byte buffer, encoded as UTF-8.

fn push_str(&mut self, string: &str)

Pushes the given string onto this string buffer.

fn capacity(&self) -> usize

Returns the number of bytes that this string buffer can hold without reallocating.

fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more bytes to be inserted in the given InlinableString. The collection may reserve more space to avoid frequent reallocations.

fn reserve_exact(&mut self, additional: usize)

Reserves the minimum capacity for exactly additional more bytes to be inserted in the given InlinableString. Does nothing if the capacity is already sufficient.

fn shrink_to_fit(&mut self)

Shrinks the capacity of this string buffer to match its length. If the string's length is less than INLINE_STRING_CAPACITY and the string is heap-allocated, then it is demoted to inline storage.

fn push(&mut self, ch: char)

Adds the given character to the end of the string.

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

Works with the underlying buffer as a byte slice.

fn truncate(&mut self, new_len: usize)

Shortens a string to the specified length.

fn pop(&mut self) -> Option<char>

Removes the last character from the string buffer and returns it. Returns None if this string buffer is empty.

fn remove(&mut self, idx: usize) -> char

Removes the character from the string buffer at byte position idx and returns it.

fn insert(&mut self, idx: usize, ch: char)

Inserts a character into the string buffer at byte position idx.

fn insert_str(&mut self, idx: usize, string: &str)

Inserts a string into the string buffer at byte position idx.

unsafe fn as_mut_slice(&mut self) -> &mut [u8]

Views the string buffer as a mutable sequence of bytes.

fn len(&self) -> usize

Returns the number of bytes in this string.

fn from_utf8_lossy(v: &'a [u8]) -> Cow<'a, str> where
    Self: Sized, 

Converts a vector of bytes to a new UTF-8 string. Any invalid UTF-8 sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

fn is_empty(&self) -> bool

Returns true if the string contains no bytes

fn clear(&mut self)

Truncates the string, returning it to 0 length.

impl StructuralEq for InlinableString

impl Write for InlinableString

fn write_char(&mut self, ch: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.