Struct PWSTR

#[repr(transparent)]
pub struct PWSTR(pub *mut u16);

A pointer to a null-terminated string of 16-bit Unicode characters.

Tuple Fields

0: *mut u16

Implementations

impl PWSTR

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

Construct a new PWSTR from a raw pointer.

pub const fn null() -> Self

Construct a null PWSTR.

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

Returns a raw pointer to the PWSTR.

pub fn is_null(&self) -> bool

Checks whether the PWSTR is null.

pub unsafe fn len(&self) -> usize

String length without the trailing 0

Safety

The PWSTR’s pointer needs to be valid for reads up until and including the next \0.

pub unsafe fn is_empty(&self) -> bool

Returns true if the string length is zero, and false otherwise.

Safety

The PWSTR’s pointer needs to be valid for reads up until and including the next \0.

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

String data without the trailing 0.

Safety

The PWSTR’s pointer needs to be valid for reads up until and including the next \0.

pub unsafe fn to_string(&self) -> Result<String, FromUtf16Error>

Copy the PWSTR into a Rust String.

Safety

See the safety information for PWSTR::as_wide.

pub unsafe fn to_hstring(&self) -> HSTRING

Copy the PWSTR into an HSTRING.

Safety

See the safety information for PWSTR::as_wide.

pub unsafe fn display(&self) -> impl Display + '_

Allow this string to be displayed.

Safety

See the safety information for PWSTR::as_wide.

Trait Implementations

impl Clone for PWSTR

fn clone(&self) -> PWSTR

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PWSTR

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

Formats the value using the given formatter.

impl PartialEq for PWSTR

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

impl Eq for PWSTR

impl StructuralPartialEq for PWSTR