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