windows_strings/
pstr.rs

1use super::*;
2
3/// A pointer to a null-terminated string of 8-bit Windows (ANSI) characters.
4#[repr(transparent)]
5#[derive(Clone, Copy, PartialEq, Eq, Debug)]
6pub struct PSTR(pub *mut u8);
7
8impl PSTR {
9    /// Construct a new `PSTR` from a raw pointer
10    pub const fn from_raw(ptr: *mut u8) -> Self {
11        Self(ptr)
12    }
13
14    /// Construct a null `PSTR`
15    pub const fn null() -> Self {
16        Self(core::ptr::null_mut())
17    }
18
19    /// Returns a raw pointer to the `PSTR`
20    pub const fn as_ptr(&self) -> *mut u8 {
21        self.0
22    }
23
24    /// Checks whether the `PSTR` is null
25    pub fn is_null(&self) -> bool {
26        self.0.is_null()
27    }
28
29    /// String data without the trailing 0
30    ///
31    /// # Safety
32    ///
33    /// The `PSTR`'s pointer needs to be valid for reads up until and including the next `\0`.
34    pub unsafe fn as_bytes(&self) -> &[u8] {
35        unsafe {
36            let len = strlen(PCSTR::from_raw(self.0));
37            core::slice::from_raw_parts(self.0, len)
38        }
39    }
40
41    /// Copy the `PSTR` into a Rust `String`.
42    ///
43    /// # Safety
44    ///
45    /// See the safety information for `PSTR::as_bytes`.
46    pub unsafe fn to_string(&self) -> core::result::Result<String, alloc::string::FromUtf8Error> {
47        unsafe { String::from_utf8(self.as_bytes().into()) }
48    }
49
50    /// Allow this string to be displayed.
51    ///
52    /// # Safety
53    ///
54    /// See the safety information for `PSTR::as_bytes`.
55    pub unsafe fn display(&self) -> impl core::fmt::Display + '_ {
56        unsafe { Decode(move || decode_utf8(self.as_bytes())) }
57    }
58}
59
60impl Default for PSTR {
61    fn default() -> Self {
62        Self::null()
63    }
64}
windows_strings/pstr.rs

windows_strings/
pstr.rs
