Struct WStrPtr 

pub struct WStrPtr(/* private fields */);

A pointer to a NUL-terminated UTF-16 string (wchar_t* on Windows), possibly null.

Reading it is unsafe: the pointer comes from the target and can’t be checked. A null pointer reads as an empty string.

Examples

use imping_runtime::WString;

let title = WString::from("Héllo");
// SAFETY: `title` is alive and NUL-terminated.
assert_eq!(unsafe { title.as_ptr().to_string_lossy() }, "Héllo");

Implementations

impl WStrPtr

pub const fn new(ptr: *const u16) -> Self

Wraps a raw pointer.

pub const fn null() -> Self

Returns a null pointer.

pub fn is_null(self) -> bool

Returns whether the pointer is null.

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

Returns the raw pointer.

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

Returns the raw pointer as *mut, for functions that write through it.

pub unsafe fn to_wide<'a>(self) -> &'a [u16]

Returns the string’s UTF-16 code units without the terminating NUL, or an empty slice if the pointer is null.

As with CStr::from_ptr, the caller chooses the lifetime 'a.

Safety

A non-null pointer must point to a NUL-terminated UTF-16 string that stays valid and unchanged for 'a.

pub unsafe fn to_string_lossy(self) -> String

Returns the string as UTF-8, with unpaired surrogates replaced by �.

Safety

A non-null pointer must point to a NUL-terminated UTF-16 string that stays valid and unchanged during the call.

Trait Implementations

impl Clone for WStrPtr

fn clone(&self) -> WStrPtr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WStrPtr

impl Debug for WStrPtr

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

Formats the value using the given formatter.

impl Default for WStrPtr

fn default() -> Self

Returns a null pointer.

impl Eq for WStrPtr

impl Hash for WStrPtr

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 PartialEq for WStrPtr

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

Equality operator ==.

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

Inequality operator !=.

impl Plain for WStrPtr

impl StructuralPartialEq for WStrPtr