Struct Wtf8Buf

pub struct Wtf8Buf {
    bytes: Vec<u8>,
    is_known_utf8: bool,
}

An owned, growable string of well-formed WTF-8 data.

Similar to String, but can additionally contain surrogate code points if they’re not in a surrogate pair.

Fields

bytes: Vec<u8>

is_known_utf8: bool

Do we know that bytes holds a valid UTF-8 encoding? We can easily know this if we’re constructed from a String or &str.

It is possible for bytes to have valid UTF-8 without this being set, such as when we’re concatenating &Wtf8’s and surrogates become paired, as we don’t bother to rescan the entire string.

Implementations

impl Wtf8Buf

pub 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 unsafe fn from_bytes_unchecked(value: Vec<u8>) -> Wtf8Buf

Creates a WTF-8 string from a WTF-8 byte vec.

Since the byte vec is not checked for valid WTF-8, this function is marked unsafe.

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 from_str(s: &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)

pub fn from_wide(v: &[u16]) -> Wtf8Buf

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

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

fn push_code_point_unchecked(&mut self, code_point: CodePoint)

Appends the given char to the end of this string. This does not include the WTF-8 concatenation check or is_known_utf8 check. Copied from String::push.

pub fn as_slice(&self) -> &Wtf8

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

fn as_known_utf8(&self) -> Option<&str>

Converts the string to UTF-8 without validation, if it was created from valid UTF-8.

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 exceeds isize::MAX bytes.

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more bytes to be inserted in the given Wtf8Buf. The Wtf8Buf may reserve more space to avoid frequent reallocations. After calling try_reserve, capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient. This method preserves the contents even if an error occurs.

Errors

If the capacity overflows, or the allocator reports a failure, then an error is returned.

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

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

Tries to reserve the minimum capacity for exactly additional more bytes to be inserted in the given Wtf8Buf. After calling try_reserve_exact, capacity will be greater than or equal to self.len() + additional if it returns Ok(()). Does nothing if the capacity is already sufficient.

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

Errors

If the capacity overflows, or the allocator reports a failure, then an error is returned.

pub fn shrink_to_fit(&mut self)

pub fn shrink_to(&mut self, min_capacity: usize)

pub fn leak<'a>(self) -> &'a mut Wtf8

pub fn capacity(&self) -> usize

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

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 WTF-8 slice 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 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_bytes(self) -> Vec<u8>

Consumes the WTF-8 string and tries to convert it to a vec of bytes.

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

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.

pub(crate) fn extend_from_slice(&mut self, other: &[u8])

Provides plumbing to core Vec::extend_from_slice. More well behaving alternative to allowing outer types full mutable access to the core Vec.

Methods from Deref<Target = Wtf8>

pub fn len(&self) -> usize

Returns the length, in WTF-8 bytes.

pub fn is_empty(&self) -> bool

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) -> Wtf8CodePoints<'_>

Returns an iterator for the string’s code points.

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

Access raw bytes of WTF-8 data

pub fn as_str(&self) -> Result<&str, Utf8Error>

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

Returns None if the string contains surrogates.

This does not copy the data.

pub fn to_owned(&self) -> Wtf8Buf

Creates an owned Wtf8Buf from a borrowed Wtf8.

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 encode_wide(&self) -> EncodeWide<'_>

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

This is lossless: calling Wtf8Buf::from_ill_formed_utf16 on the resulting code units would always return the original WTF-8 string.

fn next_surrogate(&self, pos: usize) -> Option<(usize, u16)>

fn final_lead_surrogate(&self) -> Option<u16>

fn initial_trail_surrogate(&self) -> Option<u16>

pub fn clone_into(&self, buf: &mut Wtf8Buf)

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

Boxes this Wtf8.

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

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

pub fn make_ascii_lowercase(&mut self)

pub fn make_ascii_uppercase(&mut self)

pub fn to_ascii_lowercase(&self) -> Wtf8Buf

pub fn to_ascii_uppercase(&self) -> Wtf8Buf

pub fn is_ascii(&self) -> bool

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

Trait Implementations

impl Clone for Wtf8Buf

fn clone(&self) -> Wtf8Buf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wtf8Buf

Formats the string in double quotes, with characters escaped according to char::escape_debug and unpaired surrogates represented as \u{xxxx}, where each x is a hexadecimal digit.

For example, the code units [U+0061, U+D800, U+000A] are formatted as "a\u{D800}\n".

fn fmt(&self, formatter: &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

Formats the string with unpaired surrogates substituted with the replacement character, U+FFFD.

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

Formats the value using the given formatter.

impl Eq for Wtf8Buf

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

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.

fn extend_one(&mut self, code_point: CodePoint)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

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

#[doc(hidden)] unsafe fn extend_one_unchecked(&mut self, item: A)

where Self: Sized,

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

Extends a collection with one element, without checking there is enough capacity for it.

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 Hash for Wtf8Buf

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

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 Wtf8Buf

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

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

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

#[doc(hidden)] fn __chaining_lt(&self, other: &Rhs) -> ControlFlow<bool>

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

If self == other, returns ControlFlow::Continue(()). Otherwise, returns ControlFlow::Break(self < other).

#[doc(hidden)] fn __chaining_le(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for <= instead of <.

#[doc(hidden)] fn __chaining_gt(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for > instead of <.

#[doc(hidden)] fn __chaining_ge(&self, other: &Rhs) -> ControlFlow<bool>

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

Same as __chaining_lt, but for >= instead of <.

impl StructuralPartialEq for Wtf8Buf