Struct wtf8_rs::Wtf8Buf

pub struct Wtf8Buf { /* fields omitted */ }

A WTF-8 dynamically sized, growable string.

Implementations

impl Wtf8Buf

pub const fn new() -> Wtf8Buf

Creates a new, empty WTF-8 string.

pub fn with_capacity(capacity: usize) -> Wtf8Buf

Creates a new, empty WTF-8 string with pre-allocated capacity for capacity bytes.

pub fn from_string(string: String) -> Wtf8Buf

Creates a WTF-8 string from a UTF-8 String.

This takes ownership of the String and does not copy.

Since WTF-8 is a superset of UTF-8, this always succeeds.

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

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

Panics

Panics if the new capacity overflows usize.

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

Reserves the minimum capacity for exactly additional more elements to be inserted in the given Wtf8Buf. After calling reserve_exact, capacity will be greater than or equal to self.len() + additional. 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.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

It will drop down as close as possible to the length but the allocator may still inform the vector that there is space for a few more elements.

pub fn capacity(&self) -> usize

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

pub fn from_str(str: &str) -> Wtf8Buf

Creates a WTF-8 string from a UTF-8 &str slice.

This copies the content of the slice.

Since WTF-8 is a superset of UTF-8, this always succeeds.

pub fn clear(&mut self)

Clears the string.

pub fn from_utf16<I>(v: I) -> Wtf8Buf where
    I: IntoIterator<Item = u16>, 

Creates a WTF-8 string from a potentially ill-formed UTF-16 iterator of 16-bit code units.

This is lossless: calling .encode_utf16() on the resulting string will always return the original code units.

pub fn as_wtf8(&self) -> &Wtf8

Returns the slice of this object.

pub fn as_mut_wtf8(&mut self) -> &mut Wtf8

Returns the slice of this object.

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

Append a UTF-8 slice at the end of the string.

pub fn push_wtf8(&mut self, other: &Wtf8)

Append a string with WTF-8 encoding.

This replaces newly paired surrogates at the boundary with a supplementary code point, like concatenating ill-formed UTF-16 strings effectively would.

pub fn push_char(&mut self, c: char)

Append a Unicode scalar value at the end of the string.

pub fn push(&mut self, code_point: CodePoint)

Append a code point at the end of the string.

This replaces newly paired surrogates at the boundary with a supplementary code point, like concatenating ill-formed UTF-16 strings effectively would.

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

Shortens a string to the specified length.

Panics

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

pub fn into_string(self) -> Result<String, IntoStringError>

Consumes the WTF-8 string and tries to convert it to UTF-8.

This does not copy the data.

If the contents are not well-formed UTF-8 (that is, if the string contains surrogates), the original WTF-8 string is returned instead.

pub fn into_string_lossy(self) -> String

Consumes the WTF-8 string and converts it lossily to UTF-8.

This does not copy the data (but may overwrite parts of it in place).

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

pub fn into_box(self) -> Box<Wtf8>

Converts this Wtf8Buf into a boxed Wtf8.

pub fn from_box(boxed: Box<Wtf8>) -> Wtf8Buf

Converts a Box<Wtf8> into a Wtf8Buf.

Methods from Deref<Target = Wtf8>

pub fn len(&self) -> usize

Returns the length, in WTF-8 bytes.

pub fn is_empty(&self) -> bool

Returns whether this is empty.

pub fn ascii_byte_at(&self, position: usize) -> u8

Returns the code point at position if it is in the ASCII range, or b'\xFF' otherwise.

Panics

Panics if position is beyond the end of the string.

pub fn code_points(&self) -> CodePoints<'_>

Returns an iterator for the string’s code points.

pub fn to_str(&self) -> Result<&str, ToStrError>

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

Returns Err(_) if the string contains surrogates.

This does not copy the data.

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

Lossily converts the string to UTF-8. Returns a 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 get<I: Wtf8Index>(&self, i: I) -> Option<&Self>

Returns a slice of the given string for the byte range.

Returns None whenever index would panic.

pub fn encode_utf16(&self) -> EncodeUtf16<'_>

Converts the WTF-8 string to potentially ill-formed UTF-16 and return an iterator of 16-bit code units.

pub unsafe fn get_unchecked<I: Wtf8Index>(&self, i: I) -> &Self

Returns a slice of the given string for the byte range.

Safety

Produces undefined behaviour whenever index would panic.

pub fn is_code_point_boundary(&self, index: usize) -> bool

Whether a given index is at a code point boundary.

pub fn to_box(&self) -> Box<Wtf8>

Boxes this Wtf8.

pub fn to_arc(&self) -> Arc<Wtf8>

Boxes this Wtf8 with Arc.

pub fn to_rc(&self) -> Rc<Wtf8>

Boxes this Wtf8 with Rc.

pub fn make_ascii_lowercase(&mut self)

Converts this slice to its ASCII lower case equivalent in-place.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

To return a new lowercased value without modifying the existing one, use to_ascii_lowercase.

pub fn make_ascii_uppercase(&mut self)

Converts this slice to its ASCII upper case equivalent in-place.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To return a new uppercased value without modifying the existing one, use to_ascii_uppercase.

pub fn to_ascii_lowercase(&self) -> Wtf8Buf

Returns a Wtf8Buf containing a copy of this slice where each byte is mapped to its ASCII lower case equivalent.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

pub fn to_ascii_uppercase(&self) -> Wtf8Buf

Returns a Wtf8Buf containing a copy of this slice where each byte is mapped to its ASCII upper case equivalent.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To uppercase the value in-place, use make_ascii_uppercase.

pub fn is_ascii(&self) -> bool

Checks if all bytes in this slice are within the ASCII range.

pub fn eq_ignore_ascii_case(&self, other: &Self) -> bool

Checks that two slices are an ASCII case-insensitive match.

Same as to_ascii_lowercase(a) == to_ascii_lowercase(b), but without allocating and copying temporaries.

Trait Implementations

impl AsMut<Wtf8> for Wtf8Buf

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

Performs the conversion.

impl AsRef<Wtf8> for Wtf8Buf

fn as_ref(&self) -> &Wtf8

Performs the conversion.

impl Borrow<Wtf8> for Wtf8Buf

fn borrow(&self) -> &Wtf8

Immutably borrows from an owned value.

impl BorrowMut<Wtf8> for Wtf8Buf

fn borrow_mut(&mut self) -> &mut Wtf8

Mutably borrows from an owned value.

impl Clone for Wtf8Buf

fn clone(&self) -> Wtf8Buf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wtf8Buf

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

Formats the value using the given formatter.

impl Deref for Wtf8Buf

type Target = Wtf8

The resulting type after dereferencing.

fn deref(&self) -> &Wtf8

Dereferences the value.

impl DerefMut for Wtf8Buf

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

Mutably dereferences the value.

impl Display for Wtf8Buf

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

Formats the value using the given formatter.

impl Eq for Wtf8Buf

impl<'a> Extend<&'a CodePoint> for Wtf8Buf

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 Wtf8> for Wtf8Buf

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 char> for Wtf8Buf

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 Wtf8Buf

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<CodePoint> for Wtf8Buf

Append code points from an iterator to the string.

This replaces surrogate code point pairs with supplementary code points, like concatenating ill-formed UTF-16 strings effectively would.

fn extend<T: IntoIterator<Item = CodePoint>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 Wtf8Buf

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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 From<&'_ Wtf8> for Wtf8Buf

fn from(x: &Wtf8) -> Wtf8Buf

Performs the conversion.

impl From<&'_ str> for Wtf8Buf

fn from(x: &str) -> Wtf8Buf

Performs the conversion.

impl From<String> for Wtf8Buf

fn from(x: String) -> Wtf8Buf

Performs the conversion.

impl<'a> FromIterator<&'a CodePoint> for Wtf8Buf

fn from_iter<T: IntoIterator<Item = &'a CodePoint>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl<'a> FromIterator<&'a Wtf8> for Wtf8Buf

fn from_iter<T: IntoIterator<Item = &'a Wtf8>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl<'a> FromIterator<&'a char> for Wtf8Buf

fn from_iter<T: IntoIterator<Item = &'a char>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

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

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

Creates a value from an iterator.

impl FromIterator<CodePoint> for Wtf8Buf

Creates a new WTF-8 string from an iterator of code points.

This replaces surrogate code point pairs with supplementary code points, like concatenating ill-formed UTF-16 strings effectively would.

fn from_iter<T: IntoIterator<Item = CodePoint>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl FromIterator<char> for Wtf8Buf

fn from_iter<T: IntoIterator<Item = char>>(iter: T) -> Wtf8Buf

Creates a value from an iterator.

impl FromStr for Wtf8Buf

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Infallible>

Parses a string s to return a value of this type.

impl Ord for Wtf8Buf

fn cmp(&self, other: &Wtf8Buf) -> 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 PartialEq<Wtf8Buf> for Wtf8Buf

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

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

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

This method tests for !=.

impl PartialOrd<Wtf8Buf> for Wtf8Buf

fn partial_cmp(&self, other: &Wtf8Buf) -> 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.

impl StructuralEq for Wtf8Buf

impl StructuralPartialEq for Wtf8Buf