Struct PCWSTR

#[repr(transparent)]
pub struct PCWSTR(pub *const u16);

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

Tuple Fields

0: *const u16

Implementations

impl PCWSTR

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

Construct a new PCWSTR from a raw pointer

pub const fn null() -> Self

Construct a null PCWSTR

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

Returns a raw pointer to the PCWSTR

pub fn is_null(&self) -> bool

Checks whether the PCWSTR is null

pub unsafe fn len(&self) -> usize

String length without the trailing 0

Safety

The PCWSTR’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 PCWSTR’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 PCWSTR’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 PCWSTR into a Rust String.

Safety

See the safety information for PCWSTR::as_wide.

pub unsafe fn to_hstring(&self) -> HSTRING

Copy the PCWSTR into an HSTRING.

Safety

See the safety information for PCWSTR::as_wide.

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

Allow this string to be displayed.

Safety

See the safety information for PCWSTR::as_wide.

Trait Implementations

impl AsRef<PCWSTR> for PCWSTR

fn as_ref(&self) -> &Self

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

impl Clone for PCWSTR

fn clone(&self) -> PCWSTR

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PCWSTR

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

Formats the value using the given formatter.

impl PartialEq for PCWSTR

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

impl Eq for PCWSTR

impl StructuralPartialEq for PCWSTR