Struct Wtf8

#[repr(transparent)]
pub struct Wtf8 {
    bytes: [u8],
}

A borrowed slice of well-formed WTF-8 data.

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

Fields

bytes: [u8]

Implementations

impl Wtf8

pub fn from_str(value: &str) -> &Wtf8

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

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

pub unsafe fn from_bytes_unchecked(value: &[u8]) -> &Wtf8

Creates a WTF-8 slice from a WTF-8 byte slice.

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

unsafe fn from_mut_bytes_unchecked(value: &mut [u8]) -> &mut Wtf8

Creates a mutable WTF-8 slice from a mutable WTF-8 byte slice.

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

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 empty_box() -> Box<Wtf8>

Creates a boxed, empty 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 AsInner<[u8]> for Wtf8

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

impl CloneToUninit for Wtf8

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)

Performs copy-assignment from self to dest.

impl Debug for Wtf8

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.

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

Formats the value using the given formatter.

impl Display for Wtf8

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 Wtf8

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

impl Hash for Wtf8

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

Feeds this value into the given Hasher.

impl Index<Range<usize>> for Wtf8

Returns a slice of the given string for the byte range [begin..end).

Panics

Panics when begin and end do not point to code point boundaries, or point beyond the end of the string.

type Output = Wtf8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for Wtf8

Returns a slice of the given string from byte begin to its end.

Panics

Panics when begin is not at a code point boundary, or is beyond the end of the string.

type Output = Wtf8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Wtf8

type Output = Wtf8

The returned type after indexing.

fn index(&self, _range: RangeFull) -> &Wtf8

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for Wtf8

Returns a slice of the given string from its beginning to byte end.

Panics

Panics when end is not at a code point boundary, or is beyond the end of the string.

type Output = Wtf8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Ord for Wtf8

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

This method returns an Ordering between self and other.

impl PartialEq for Wtf8

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

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