Struct widestring::utfstr::Utf16Str

pub struct Utf16Str { /* private fields */ }

UTF-16 string slice for Utf16String.

Utf16Str is to Utf16String as str is to String.

Utf16Str slices are string slices that are always valid UTF-16 encoding. This is unlike the U16Str string slices, which may not have valid encoding. In this way, Utf16Str string slices most resemble native str slices of all the types in this crate.

Examples

The easiest way to use Utf16Str is with the utf16str! macro to convert string literals into string slices at compile time:

use widestring::utf16str;
let hello = utf16str!("Hello, world!");

You can also convert a u16 slice directly, provided it is valid UTF-16:

use widestring::Utf16Str;

let sparkle_heart = [0xd83d, 0xdc96];
let sparkle_heart = Utf16Str::from_slice(&sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

Implementations

impl Utf16Str

pub const unsafe fn from_slice_unchecked(s: &[u16]) -> &Self

Converts a slice to a string slice without checking that the string contains valid UTF-16.

See the safe version, from_slice, for more information.

Safety

This function is unsafe because it does not check that the slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

Examples

use widestring::Utf16Str;

let sparkle_heart = vec![0xd83d, 0xdc96]; // Raw surrogate pair
let sparkle_heart = unsafe { Utf16Str::from_slice_unchecked(&sparkle_heart) };

assert_eq!("💖", sparkle_heart);

pub unsafe fn from_slice_unchecked_mut(s: &mut [u16]) -> &mut Self

Converts a mutable slice to a mutable string slice without checking that the string contains valid UTF-16.

See the safe version, from_slice_mut, for more information.

Safety

This function is unsafe because it does not check that the slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

Examples

use widestring::Utf16Str;

let mut sparkle_heart = vec![0xd83d, 0xdc96]; // Raw surrogate pair
let sparkle_heart = unsafe { Utf16Str::from_slice_unchecked_mut(&mut sparkle_heart) };

assert_eq!("💖", sparkle_heart);

pub unsafe fn from_boxed_slice_unchecked(s: Box<[u16]>) -> Box<Self>

Converts a boxed slice to a boxed string slice without checking that the string contains valid UTF-16.

Safety

This function is unsafe because it does not check if the string slice is valid UTF-16, and Utf16Str must always be valid UTF-16.

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

where I: SliceIndex<[u16], Output = [u16]>,

Returns an unchecked subslice of this string slice.

This is the unchecked alternative to indexing the string slice.

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original slice;
• Indexes must lie on UTF-16 sequence boundaries.

Failing that, the returned string slice may reference invalid memory or violate the invariants communicated by the type.

Examples

let v = utf16str!("⚧️🏳️‍⚧️➡️s");
unsafe {
    assert_eq!(utf16str!("⚧️"), v.get_unchecked(..2));
    assert_eq!(utf16str!("🏳️‍⚧️"), v.get_unchecked(2..8));
    assert_eq!(utf16str!("➡️"), v.get_unchecked(8..10));
    assert_eq!(utf16str!("s"), v.get_unchecked(10..));
}

pub unsafe fn get_unchecked_mut<I>(&mut self, index: I) -> &mut Self

where I: SliceIndex<[u16], Output = [u16]>,

Returns a mutable, unchecked subslice of this string slice

This is the unchecked alternative to indexing the string slice.

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original slice;
• Indexes must lie on UTF-16 sequence boundaries.

Failing that, the returned string slice may reference invalid memory or violate the invariants communicated by the type.

Examples

let mut v = utf16str!("⚧️🏳️‍⚧️➡️s").to_owned();
unsafe {
    assert_eq!(utf16str!("⚧️"), v.get_unchecked_mut(..2));
    assert_eq!(utf16str!("🏳️‍⚧️"), v.get_unchecked_mut(2..8));
    assert_eq!(utf16str!("➡️"), v.get_unchecked_mut(8..10));
    assert_eq!(utf16str!("s"), v.get_unchecked_mut(10..));
}

pub const fn len(&self) -> usize

Returns the length of self.

This length is in u16 values, not chars or graphemes. In other words, it may not be what human considers the length of the string.

Examples

assert_eq!(utf16str!("foo").len(), 3);

let complex = utf16str!("⚧️🏳️‍⚧️➡️s");
assert_eq!(complex.len(), 11);
assert_eq!(complex.chars().count(), 10);

pub const fn is_empty(&self) -> bool

Returns true if the string has a length of zero.

pub const fn as_slice(&self) -> &[u16]

Converts a string to a slice of its underlying elements.

To convert the slice back into a string slice, use the from_slice function.

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

Converts a mutable string to a mutable slice of its underlying elements.

Safety

This function is unsafe because you can violate the invariants of this type when mutating the slice. The caller must ensure that the contents of the slice is valid UTF before the borrow ends and the underlying string is used.

Use of this string type whose contents have been mutated to invalid UTF is undefined behavior.

pub const fn as_ptr(&self) -> *const u16

Converts a string slice to a raw pointer.

This pointer will be pointing to the first element of the string slice.

The caller must ensure that the returned pointer is never written to. If you need to mutate the contents of the string slice, use as_mut_ptr.

pub fn as_mut_ptr(&mut self) -> *mut u16

Converts a mutable string slice to a mutable pointer.

This pointer will be pointing to the first element of the string slice.

pub const fn as_ustr(&self) -> &U16Str

Returns this string as a wide string slice of undefined encoding.

pub fn trim(&self) -> &Self

Returns a string slice with leading and trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

pub fn trim_start(&self) -> &Self

Returns a string slice with leading whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

Text directionality

A string is a sequence of elements. start in this context means the first position of that sequence; for a left-to-right language like English or Russian, this will be left side, and for right-to-left languages like Arabic or Hebrew, this will be the right side.

pub fn trim_end(&self) -> &Self

Returns a string slice with trailing whitespace removed.

‘Whitespace’ is defined according to the terms of the Unicode Derived Core Property White_Space.

Text directionality

A string is a sequence of elements. end in this context means the last position of that sequence; for a left-to-right language like English or Russian, this will be right side, and for right-to-left languages like Arabic or Hebrew, this will be the left side.

pub fn into_boxed_slice(self: Box<Self>) -> Box<[u16]>

Converts a boxed string into a boxed slice without copying or allocating.

pub fn into_utfstring(self: Box<Self>) -> Utf16String

Converts a boxed string slice into an owned UTF string without copying or allocating.

pub fn repeat(&self, n: usize) -> Utf16String

Creates a new owned string by repeating this string n times.

Panics

This function will panic if the capacity would overflow.

impl Utf16Str

pub fn from_slice(s: &[u16]) -> Result<&Self, Utf16Error>

Converts a slice of UTF-16 data to a string slice.

Not all slices of u16 values are valid to convert, since Utf16Str requires that it is always valid UTF-16. This function checks to ensure that the values are valid UTF-16, and then does the conversion.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_slice_unchecked, which has the same behavior but skips the check.

If you need an owned string, consider using Utf16String::from_vec instead.

Because you can stack-allocate a [u16; N], this function is one way to have a stack-allocated string. Indeed, the utf16str! macro does exactly this after converting from UTF-8 to UTF-16.

Errors

Returns an error if the slice is not UTF-16 with a description as to why the provided slice is not UTF-16.

Examples

use widestring::Utf16Str;

let sparkle_heart = vec![0xd83d, 0xdc96]; // Raw surrogate pair
let sparkle_heart = Utf16Str::from_slice(&sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

With incorrect values that return an error:

use widestring::Utf16Str;

let sparkle_heart = vec![0xd83d, 0x0]; // This is an invalid unpaired surrogate

assert!(Utf16Str::from_slice(&sparkle_heart).is_err());

pub fn from_slice_mut(s: &mut [u16]) -> Result<&mut Self, Utf16Error>

Converts a mutable slice of UTF-16 data to a mutable string slice.

Not all slices of u16 values are valid to convert, since Utf16Str requires that it is always valid UTF-16. This function checks to ensure that the values are valid UTF-16, and then does the conversion.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_slice_unchecked_mut, which has the same behavior but skips the check.

If you need an owned string, consider using Utf16String::from_vec instead.

Because you can stack-allocate a [u16; N], this function is one way to have a stack-allocated string. Indeed, the utf16str! macro does exactly this after converting from UTF-8 to UTF-16.

Errors

Returns an error if the slice is not UTF-16 with a description as to why the provided slice is not UTF-16.

Examples

use widestring::Utf16Str;

let mut sparkle_heart = vec![0xd83d, 0xdc96]; // Raw surrogate pair
let sparkle_heart = Utf16Str::from_slice_mut(&mut sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

With incorrect values that return an error:

use widestring::Utf16Str;

let mut sparkle_heart = vec![0xd83d, 0x0]; // This is an invalid unpaired surrogate

assert!(Utf16Str::from_slice_mut(&mut sparkle_heart).is_err());

pub const unsafe fn from_ustr_unchecked(s: &U16Str) -> &Self

Converts a wide string slice of undefined encoding to a UTF-16 string slice without checking if the string slice is valid UTF-16.

See the safe version, from_ustr, for more information.

Safety

This function is unsafe because it does not check that the string slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

Examples

use widestring::{Utf16Str, u16str};

let sparkle_heart = u16str!("💖");
let sparkle_heart = unsafe { Utf16Str::from_ustr_unchecked(sparkle_heart) };

assert_eq!("💖", sparkle_heart);

pub unsafe fn from_ustr_unchecked_mut(s: &mut U16Str) -> &mut Self

Converts a mutable wide string slice of undefined encoding to a mutable UTF-16 string slice without checking if the string slice is valid UTF-16.

See the safe version, from_ustr_mut, for more information.

Safety

This function is unsafe because it does not check that the string slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

pub fn from_ustr(s: &U16Str) -> Result<&Self, Utf16Error>

Converts a wide string slice of undefined encoding to a UTF-16 string slice.

Since U16Str does not have a specified encoding, this conversion may fail if the U16Str does not contain valid UTF-16 data.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_ustr_unchecked, which has the same behavior but skips the check.

Errors

Returns an error if the string slice is not UTF-16 with a description as to why the provided string slice is not UTF-16.

Examples

use widestring::{Utf16Str, u16str};

let sparkle_heart = u16str!("💖");
let sparkle_heart = Utf16Str::from_ustr(sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

pub fn from_ustr_mut(s: &mut U16Str) -> Result<&mut Self, Utf16Error>

Converts a mutable wide string slice of undefined encoding to a mutable UTF-16 string slice.

Since U16Str does not have a specified encoding, this conversion may fail if the U16Str does not contain valid UTF-16 data.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_ustr_unchecked_mut, which has the same behavior but skips the check.

Errors

Returns an error if the string slice is not UTF-16 with a description as to why the provided string slice is not UTF-16.

pub unsafe fn from_ucstr_unchecked(s: &U16CStr) -> &Self

Converts a wide C string slice to a UTF-16 string slice without checking if the string slice is valid UTF-16.

The resulting string slice does not contain the nul terminator.

See the safe version, from_ucstr, for more information.

Safety

This function is unsafe because it does not check that the string slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

Examples

use widestring::{Utf16Str, u16cstr};

let sparkle_heart = u16cstr!("💖");
let sparkle_heart = unsafe { Utf16Str::from_ucstr_unchecked(sparkle_heart) };

assert_eq!("💖", sparkle_heart);

pub unsafe fn from_ucstr_unchecked_mut(s: &mut U16CStr) -> &mut Self

Converts a mutable wide C string slice to a mutable UTF-16 string slice without checking if the string slice is valid UTF-16.

The resulting string slice does not contain the nul terminator.

See the safe version, from_ucstr_mut, for more information.

Safety

This function is unsafe because it does not check that the string slice passed to it is valid UTF-16. If this constraint is violated, undefined behavior results as it is assumed the Utf16Str is always valid UTF-16.

pub fn from_ucstr(s: &U16CStr) -> Result<&Self, Utf16Error>

Converts a wide C string slice to a UTF-16 string slice.

The resulting string slice does not contain the nul terminator.

Since U16CStr does not have a specified encoding, this conversion may fail if the U16CStr does not contain valid UTF-16 data.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_ucstr_unchecked, which has the same behavior but skips the check.

Errors

Returns an error if the string slice is not UTF-16 with a description as to why the provided string slice is not UTF-16.

Examples

use widestring::{Utf16Str, u16cstr};

let sparkle_heart = u16cstr!("💖");
let sparkle_heart = Utf16Str::from_ucstr(sparkle_heart).unwrap();

assert_eq!("💖", sparkle_heart);

pub unsafe fn from_ucstr_mut(s: &mut U16CStr) -> Result<&mut Self, Utf16Error>

Converts a mutable wide C string slice to a mutable UTF-16 string slice.

The resulting string slice does not contain the nul terminator.

Since U16CStr does not have a specified encoding, this conversion may fail if the U16CStr does not contain valid UTF-16 data.

If you are sure that the slice is valid UTF-16, and you don’t want to incur the overhead of the validity check, there is an unsafe version of this function, from_ucstr_unchecked_mut, which has the same behavior but skips the check.

Safety

This method is unsafe because you can violate the invariants of U16CStr when mutating the slice (i.e. by adding interior nul values).

Errors

Returns an error if the string slice is not UTF-16 with a description as to why the provided string slice is not UTF-16.

pub fn to_string(&self) -> String

Converts to a standard UTF-8 String.

Because this string is always valid UTF-16, the conversion is lossless and non-fallible.

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

Checks that index-th value is the value in a UTF-16 code point sequence or the end of the string.

Returns true if the value at index is not a UTF-16 surrogate value, or if the value at index is the first value of a surrogate pair (the “high” surrogate). Returns false if the value at index is the second value of a surrogate pair (a.k.a the “low” surrogate).

The start and end of the string (when index == self.len()) are considered to be boundaries.

Returns false if index is greater than self.len()`.

Examples

let s = utf16str!("Sparkle 💖 Heart");
assert!(s.is_char_boundary(0));

// high surrogate of `💖`
assert!(s.is_char_boundary(8));
// low surrogate of `💖`
assert!(!s.is_char_boundary(9));

assert!(s.is_char_boundary(s.len()));

pub fn get<I>(&self, index: I) -> Option<&Self>

where I: RangeBounds<usize> + SliceIndex<[u16], Output = [u16]>,

Returns a subslice of this string.

This is the non-panicking alternative to indexing the string. Returns None whenever equivalent indexing operation would panic.

Examples

let v = utf16str!("⚧️🏳️‍⚧️➡️s");

assert_eq!(Some(utf16str!("⚧️")), v.get(..2));
assert_eq!(Some(utf16str!("🏳️‍⚧️")), v.get(2..8));
assert_eq!(Some(utf16str!("➡️")), v.get(8..10));
assert_eq!(Some(utf16str!("s")), v.get(10..));

assert!(v.get(3..4).is_none());

pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Self>

where I: RangeBounds<usize> + SliceIndex<[u16], Output = [u16]>,

Returns a mutable subslice of this string.

This is the non-panicking alternative to indexing the string. Returns None whenever equivalent indexing operation would panic.

Examples

let mut v = utf16str!("⚧️🏳️‍⚧️➡️s").to_owned();

assert_eq!(utf16str!("⚧️"), v.get_mut(..2).unwrap());
assert_eq!(utf16str!("🏳️‍⚧️"), v.get_mut(2..8).unwrap());
assert_eq!(utf16str!("➡️"), v.get_mut(8..10).unwrap());
assert_eq!(utf16str!("s"), v.get_mut(10..).unwrap());

assert!(v.get_mut(3..4).is_none());

pub fn split_at(&self, mid: usize) -> (&Self, &Self)

Divide one string slice into two at an index.

The argument, mid, should be an offset from the start of the string. It must also be on the boundary of a UTF-16 code point.

The two slices returned go from the start of the string slice to mid, and from mid to the end of the string slice.

To get mutable string slices instead, see the split_at_mut method.

Panics

Panics if mid is not on a UTF-16 code point boundary, or if it is past the end of the last code point of the string slice.

Examples

let s = utf16str!("Per Martin-Löf");

let (first, last) = s.split_at(3);

assert_eq!("Per", first);
assert_eq!(" Martin-Löf", last);

pub fn split_at_mut(&mut self, mid: usize) -> (&mut Self, &mut Self)

Divide one mutable string slice into two at an index.

The argument, mid, should be an offset from the start of the string. It must also be on the boundary of a UTF-16 code point.

The two slices returned go from the start of the string slice to mid, and from mid to the end of the string slice.

To get immutable string slices instead, see the split_at method.

Panics

Panics if mid is not on a UTF-16 code point boundary, or if it is past the end of the last code point of the string slice.

Examples

let mut s = utf16str!("Per Martin-Löf").to_owned();

let (first, last) = s.split_at_mut(3);

assert_eq!("Per", first);
assert_eq!(" Martin-Löf", last);

pub fn chars(&self) -> CharsUtf16<'_>

Returns an iterator over the chars of a string slice.

As this string slice consists of valid UTF-16, we can iterate through a string slice by char. This method returns such an iterator.

It’s important to remember that char represents a Unicode Scalar Value, and might not match your idea of what a ‘character’ is. Iteration over grapheme clusters may be what you actually want. This functionality is not provided by this crate.

pub fn char_indices(&self) -> CharIndicesUtf16<'_>

Returns an iterator over the chars of a string slice and their positions.

As this string slice consists of valid UTF-16, we can iterate through a string slice by char. This method returns an iterator of both these chars as well as their offsets.

The iterator yields tuples. The position is first, the char is second.

pub fn code_units(&self) -> CodeUnits<'_>

An iterator over the u16 code units of a string slice.

As a UTF-16 string slice consists of a sequence of u16 code units, we can iterate through a string slice by each code unit. This method returns such an iterator.

pub fn encode_utf8(&self) -> EncodeUtf8<CharsUtf16<'_>>

Returns an iterator of bytes over the string encoded as UTF-8.

pub fn encode_utf32(&self) -> EncodeUtf32<CharsUtf16<'_>>

Returns an iterator of u32 over the sting encoded as UTF-32.

pub fn escape_debug(&self) -> EscapeDebug<CharsUtf16<'_>>

Returns an iterator that escapes each char in self with char::escape_debug.

pub fn escape_default(&self) -> EscapeDefault<CharsUtf16<'_>>

Returns an iterator that escapes each char in self with char::escape_default.

pub fn escape_unicode(&self) -> EscapeUnicode<CharsUtf16<'_>>

Returns an iterator that escapes each char in self with char::escape_unicode.

pub fn to_lowercase(&self) -> Utf16String

Returns the lowercase equivalent of this string slice, as a new Utf16String.

‘Lowercase’ is defined according to the terms of the Unicode Derived Core Property Lowercase.

Since some characters can expand into multiple characters when changing the case, this function returns a Utf16String instead of modifying the parameter in-place.

pub fn to_uppercase(&self) -> Utf16String

Returns the uppercase equivalent of this string slice, as a new Utf16String.

‘Uppercase’ is defined according to the terms of the Unicode Derived Core Property Uppercase.

Since some characters can expand into multiple characters when changing the case, this function returns a Utf16String instead of modifying the parameter in-place.

Trait Implementations

impl Add<&Utf16Str> for U16String

type Output = U16String

The resulting type after applying the + operator.

fn add(self, rhs: &Utf16Str) -> Self::Output

Performs the + operation.

impl Add<&Utf16Str> for Utf16String

type Output = Utf16String

The resulting type after applying the + operator.

fn add(self, rhs: &Utf16Str) -> Self::Output

Performs the + operation.

impl AddAssign<&Utf16Str> for U16String

fn add_assign(&mut self, rhs: &Utf16Str)

Performs the += operation.

impl AddAssign<&Utf16Str> for Utf16String

fn add_assign(&mut self, rhs: &Utf16Str)

Performs the += operation.

impl AsMut<Utf16Str> for Utf16Str

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Utf16Str> for Utf16String

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u16]> for Utf16Str

fn as_ref(&self) -> &[u16]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<U16Str> for Utf16Str

fn as_ref(&self) -> &U16Str

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Utf16Str> for Utf16Str

fn as_ref(&self) -> &Utf16Str

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Utf16Str> for Utf16String

fn as_ref(&self) -> &Utf16Str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Utf16Str> for Utf16String

fn borrow(&self) -> &Utf16Str

Immutably borrows from an owned value.

impl BorrowMut<Utf16Str> for Utf16String

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

Mutably borrows from an owned value.

impl Debug for Utf16Str

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

Formats the value using the given formatter.

impl Default for &Utf16Str

fn default() -> Self

Returns the “default value” for a type.

impl Default for &mut Utf16Str

fn default() -> Self

Returns the “default value” for a type.

impl Display for Utf16Str

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

Formats the value using the given formatter.

impl<'a> Extend<&'a Utf16Str> for U16String

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

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 Utf16Str> for Utf16String

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

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 Utf16Str> for &'a [u16]

fn from(value: &'a Utf16Str) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Utf16Str> for &'a U16Str

fn from(value: &'a Utf16Str) -> Self

Converts to this type from the input type.

impl From<&Utf16Str> for OsString

fn from(value: &Utf16Str) -> OsString

Converts to this type from the input type.

impl From<&Utf16Str> for String

fn from(value: &Utf16Str) -> Self

Converts to this type from the input type.

impl From<&Utf16Str> for Utf16String

fn from(value: &Utf16Str) -> Self

Converts to this type from the input type.

impl From<&mut Utf16Str> for Utf16String

fn from(value: &mut Utf16Str) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a Utf16Str> for U16String

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

Creates a value from an iterator.

impl<'a> FromIterator<&'a Utf16Str> for Utf16String

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

Creates a value from an iterator.

impl Hash for Utf16Str

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

Feeds this value into the given Hasher.

impl<I> Index<I> for Utf16Str

where I: RangeBounds<usize> + SliceIndex<[u16], Output = [u16]>,

type Output = Utf16Str

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<I> IndexMut<I> for Utf16Str

where I: RangeBounds<usize> + SliceIndex<[u16], Output = [u16]>,

fn index_mut(&mut self, index: I) -> &mut Self::Output

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

impl Ord for Utf16Str

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

This method returns an Ordering between self and other.

impl<'a, 'b> PartialEq<&'a Utf16Str> for Cow<'b, Utf16Str>

fn eq(&self, other: &&'a Utf16Str) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<&'a Utf16Str> for Cow<'b, str>

fn eq(&self, other: &&'a Utf16Str) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&Utf16Str> for Utf16String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&Utf16Str> for Utf32Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&Utf16Str> for Utf32String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&Utf32Str> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<Cow<'a, Utf16Str>> for &'b Utf16Str

fn eq(&self, other: &Cow<'a, Utf16Str>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> PartialEq<Cow<'a, str>> for &'b Utf16Str

fn eq(&self, other: &Cow<'a, str>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<U16CStr> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<U16CString> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<U16Str> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<U16String> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for &Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for &Utf32Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for &str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for Cow<'_, Utf16Str>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for Cow<'_, str>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for U16CStr

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for U16CString

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for U16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for U16String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for Utf16String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for Utf32Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16Str> for str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16String> for &Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf16String> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf32Str> for &Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf32Str> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Utf32String> for &Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for &Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Utf16Str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Utf16Str

fn partial_cmp(&self, other: &Utf16Str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

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 ToOwned for Utf16Str

type Owned = Utf16String

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a [u16]> for &'a Utf16Str

type Error = Utf16Error

The type returned in the event of a conversion error.

fn try_from(value: &'a [u16]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a U16CStr> for &'a Utf16Str

type Error = Utf16Error

The type returned in the event of a conversion error.

fn try_from(value: &'a U16CStr) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a U16Str> for &'a Utf16Str

type Error = Utf16Error

The type returned in the event of a conversion error.

fn try_from(value: &'a U16Str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut [u16]> for &'a mut Utf16Str

type Error = Utf16Error

The type returned in the event of a conversion error.

fn try_from(value: &'a mut [u16]) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Utf16Str

impl StructuralPartialEq for Utf16Str