diff options
Diffstat (limited to 'vendor/windows-strings/src/pcwstr.rs')
| -rw-r--r-- | vendor/windows-strings/src/pcwstr.rs | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/vendor/windows-strings/src/pcwstr.rs b/vendor/windows-strings/src/pcwstr.rs new file mode 100644 index 00000000..221bfd9b --- /dev/null +++ b/vendor/windows-strings/src/pcwstr.rs @@ -0,0 +1,97 @@ +use super::*; + +/// A pointer to a constant null-terminated string of 16-bit Unicode characters. +#[repr(transparent)] +#[derive(Clone, Copy, PartialEq, Eq, Debug)] +pub struct PCWSTR(pub *const u16); + +impl PCWSTR { + /// Construct a new `PCWSTR` from a raw pointer + pub const fn from_raw(ptr: *const u16) -> Self { + Self(ptr) + } + + /// Construct a null `PCWSTR` + pub const fn null() -> Self { + Self(core::ptr::null()) + } + + /// Returns a raw pointer to the `PCWSTR` + pub const fn as_ptr(&self) -> *const u16 { + self.0 + } + + /// Checks whether the `PCWSTR` is null + pub fn is_null(&self) -> bool { + self.0.is_null() + } + + /// 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 len(&self) -> usize { + extern "C" { + fn wcslen(s: *const u16) -> usize; + } + unsafe { wcslen(self.0) } + } + + /// 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 is_empty(&self) -> bool { + unsafe { self.len() == 0 } + } + + /// 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 as_wide(&self) -> &[u16] { + unsafe { core::slice::from_raw_parts(self.0, self.len()) } + } + + /// Copy the `PCWSTR` into a Rust `String`. + /// + /// # Safety + /// + /// See the safety information for `PCWSTR::as_wide`. + pub unsafe fn to_string(&self) -> core::result::Result<String, alloc::string::FromUtf16Error> { + unsafe { String::from_utf16(self.as_wide()) } + } + + /// Copy the `PCWSTR` into an `HSTRING`. + /// + /// # Safety + /// + /// See the safety information for `PCWSTR::as_wide`. + pub unsafe fn to_hstring(&self) -> HSTRING { + unsafe { HSTRING::from_wide(self.as_wide()) } + } + + /// Allow this string to be displayed. + /// + /// # Safety + /// + /// See the safety information for `PCWSTR::as_wide`. + pub unsafe fn display(&self) -> impl core::fmt::Display + '_ { + unsafe { Decode(move || core::char::decode_utf16(self.as_wide().iter().cloned())) } + } +} + +impl Default for PCWSTR { + fn default() -> Self { + Self::null() + } +} + +impl AsRef<PCWSTR> for PCWSTR { + fn as_ref(&self) -> &Self { + self + } +} |
