Type Alias Wtf16Str 

pub type Wtf16Str = WtfStr<Wtf16>;

A WtfStr whose storage is WTF-16 (u16 code units).

Aliased Type

pub struct Wtf16Str { /* private fields */ }

Implementations

impl Wtf16Str

pub fn to_os_string(&self) -> OsString

Decode the content into an owned OsString, losslessly.

The OsStringExt::from_wide bridge: unpaired surrogates are preserved.

pub fn encode_wide(&self) -> impl Iterator<Item = u16> + '_

Iterate the content as wide code units, zero-copy: the OsStrExt::encode_wide analog over our own slice.

impl Wtf16Str

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

A pointer to the content code units, for counted FFI paired with len.

The pointer is not guaranteed to be NUL-terminated (a borrowed slice carries no terminator); use it only with the matching unit count. It is valid while self is borrowed and unmodified. For a terminated LPCWSTR, start from an owned Wtf16String and use Wtf16String::as_terminated_ptr.

Examples found in repository

examples/win32_round_trip.rs (line 147)

    fn ordinal(a: &Wtf16Str, b: &Wtf16Str) -> i32 {
        // SAFETY: each pointer is valid for exactly its own `len()` units while
        // borrowed, which is the contract `CompareStringOrdinal` expects.
        unsafe {
            CompareStringOrdinal(
                a.as_ptr(),
                a.len() as i32,
                b.as_ptr(),
                b.len() as i32,
                0, // case-sensitive
            )
        }
    }