Trait inlinable_string::string_ext::StringExt[−][src]

pub trait StringExt<'a>: Borrow<str> + Display + PartialEq<str> + PartialEq<&'a str> + PartialEq<String> + PartialEq<Cow<'a, str>> {

Show 25 methods    fn new() -> Self
    where
        Self: Sized;

    fn with_capacity(capacity: usize) -> Self
    where
        Self: Sized;

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

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

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

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

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

    fn into_bytes(self) -> Vec<u8>;

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

    fn capacity(&self) -> usize;

    fn reserve(&mut self, additional: usize);

    fn reserve_exact(&mut self, additional: usize);

    fn shrink_to_fit(&mut self);

    fn push(&mut self, ch: char);

    fn as_bytes(&self) -> &[u8]ⓘ
Notable traits for &'_ mut [u8]
impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]
;

    fn truncate(&mut self, new_len: usize);

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

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

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

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

    unsafe fn as_mut_slice(&mut self) -> &mut [u8]ⓘ
Notable traits for &'_ mut [u8]
impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]
;

    fn len(&self) -> usize;

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

    fn is_empty(&self) -> bool { ... }

    fn clear(&mut self) { ... }

}
Expand description

A trait that exists to abstract string operations over any number of concrete string type implementations.

See the crate level documentation for more.

Required methods

Creates a new string buffer initialized with the empty string.

Examples
use inlinable_string::{InlinableString, StringExt};

let s = InlinableString::new();

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.

Examples
use inlinable_string::{InlinableString, StringExt};

let s = InlinableString::with_capacity(10);

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

Failure

If the given vector is not valid UTF-8, then the original vector and the corresponding error is returned.

Examples
use inlinable_string::{InlinableString, StringExt};

let hello_vec = vec![104, 101, 108, 108, 111];
let s = InlinableString::from_utf8(hello_vec).unwrap();
assert_eq!(s, "hello");

let invalid_vec = vec![240, 144, 128];
let s = InlinableString::from_utf8(invalid_vec).err().unwrap();
let err = s.utf8_error();
assert_eq!(s.into_bytes(), [240, 144, 128]);

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

Examples
use inlinable_string::{InlinableString, StringExt};

// 𝄞music
let mut v = &mut [0xD834, 0xDD1E, 0x006d, 0x0075,
                  0x0073, 0x0069, 0x0063];
assert_eq!(InlinableString::from_utf16(v).unwrap(),
           InlinableString::from("𝄞music"));

// 𝄞mu<invalid>ic
v[4] = 0xD800;
assert!(InlinableString::from_utf16(v).is_err());

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

Examples
use inlinable_string::{InlinableString, StringExt};

// 𝄞mus<invalid>ic<invalid>
let v = &[0xD834, 0xDD1E, 0x006d, 0x0075,
          0x0073, 0xDD1E, 0x0069, 0x0063,
          0xD834];

assert_eq!(InlinableString::from_utf16_lossy(v),
           InlinableString::from("𝄞mus\u{FFFD}ic\u{FFFD}"));

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

Safety

This is very unsafe because:

  • We call String::from_raw_parts to get a Vec<u8>. Therefore, this function inherits all of its unsafety, see its documentation for the invariants it expects, they also apply to this function.

  • We assume that the Vec contains valid UTF-8.

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

Safety

This is unsafe because it assumes that the UTF-8-ness of the vector has already been validated.

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

Examples
use inlinable_string::{InlinableString, StringExt};

let s = InlinableString::from("hello");
let bytes = s.into_bytes();
assert_eq!(bytes, [104, 101, 108, 108, 111]);

Pushes the given string onto this string buffer.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
s.push_str("bar");
assert_eq!(s, "foobar");

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

Examples
use inlinable_string::{InlinableString, StringExt};

let s = InlinableString::with_capacity(10);
assert!(s.capacity() >= 10);

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.

Panics

Panics if the new capacity overflows usize.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::new();
s.reserve(10);
assert!(s.capacity() >= 10);

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

Note that the allocator may give the collection more space than it requests. Therefore capacity can not be relied upon to be precisely minimal. Prefer reserve if future insertions are expected.

Panics

Panics if the new capacity overflows usize.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::new();
s.reserve_exact(10);
assert!(s.capacity() >= 10);

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.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
s.reserve(100);
assert!(s.capacity() >= 100);
s.shrink_to_fit();
assert_eq!(s.capacity(), inlinable_string::INLINE_STRING_CAPACITY);

Adds the given character to the end of the string.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("abc");
s.push('1');
s.push('2');
s.push('3');
assert_eq!(s, "abc123");

Works with the underlying buffer as a byte slice.

Examples
use inlinable_string::{InlinableString, StringExt};

let s = InlinableString::from("hello");
assert_eq!(s.as_bytes(), [104, 101, 108, 108, 111]);

Shortens a string to the specified length.

Panics

Panics if new_len > current length, or if new_len is not a character boundary.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("hello");
s.truncate(2);
assert_eq!(s, "he");

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

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('o'));
assert_eq!(s.pop(), Some('f'));
assert_eq!(s.pop(), None);

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

Warning

This is an O(n) operation as it requires copying every element in the buffer.

Panics

If idx does not lie on a character boundary, or if it is out of bounds, then this function will panic.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
assert_eq!(s.remove(0), 'f');
assert_eq!(s.remove(1), 'o');
assert_eq!(s.remove(0), 'o');

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

Warning

This is an O(n) operation as it requires copying every element in the buffer.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
s.insert(2, 'f');
assert!(s == "fofo");
Panics

If idx does not lie on a character boundary or is out of bounds, then this function will panic.

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

Warning

This is an O(n) operation as it requires copying every element in the buffer.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
s.insert_str(2, "bar");
assert!(s == "fobaro");
Panics

If idx does not lie on a character boundary or is out of bounds, then this function will panic.

Views the string buffer as a mutable sequence of bytes.

Safety

This is unsafe because it does not check to ensure that the resulting string will be valid UTF-8.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("hello");
unsafe {
    let slice = s.as_mut_slice();
    assert!(slice == &[104, 101, 108, 108, 111]);
    slice.reverse();
}
assert_eq!(s, "olleh");

Returns the number of bytes in this string.

Examples
use inlinable_string::{InlinableString, StringExt};

let a = InlinableString::from("foo");
assert_eq!(a.len(), 3);

Provided methods

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

Examples
use inlinable_string::{InlinableString, StringExt};

let input = b"Hello \xF0\x90\x80World";
let output = InlinableString::from_utf8_lossy(input);
assert_eq!(output, "Hello \u{FFFD}World");

Returns true if the string contains no bytes

Examples
use inlinable_string::{InlinableString, StringExt};

let mut v = InlinableString::new();
assert!(v.is_empty());
v.push('a');
assert!(!v.is_empty());

Truncates the string, returning it to 0 length.

Examples
use inlinable_string::{InlinableString, StringExt};

let mut s = InlinableString::from("foo");
s.clear();
assert!(s.is_empty());

Implementations on Foreign Types

Implementors