faithe 0.8.0

Windows memory hacking library.
Documentation 
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

cfg_if::cfg_if! {
    if #[cfg(not(feature = "no-std"))] {
        mod winapi;
        pub use winapi::*;
    }
}

cfg_if::cfg_if! {
    if #[cfg(any(not(feature = "no-std"), feature = "alloc"))] {
        mod string;
        pub use string::UnicodeString;

        extern crate alloc;
        use alloc::string::String;
    }
}

mod entry;
pub use entry::*;

use core::ptr::NonNull;

/// Zero terminated ascii string. Have the same layout as `*const u8`.
/// Used for convenience so it can be returned from extern funcs.
#[derive(Debug, Clone)]
#[repr(transparent)]
pub struct StrPtr(NonNull<u8>);

impl StrPtr {
    /// Converts pointer into string slice.
    /// # Safety
    /// `StrPtr` must point to valid memory.
    #[inline]
    pub unsafe fn to_str<'a>(&self) -> &'a str {
        std::str::from_utf8_unchecked(crate::terminated_array(self.0.as_ptr(), &0))
    }

    /// Converts pointer to string by cloning data.
    /// # Safety
    /// `StrPtr` must point to valid memory.
    #[inline]
    pub unsafe fn into_string(self) -> String {
        self.to_str().into()
    }

    /// Creates new [`StrPtr`] from pointer without checking if it's null.
    /// # Safety
    /// `p` must not be `null`.
    #[inline(always)]
    pub const unsafe fn new_unchecked(p: *const u8) -> Self {
        Self(NonNull::new_unchecked(p as _))
    }

    /// Creates new [`StrPtr`] from pointer.
    #[inline(always)]
    pub fn new(p: *const u8) -> Option<Self> {
        Some(Self(NonNull::new(p as _)?))
    }

    /// Returns the pointer to the string.
    #[inline(always)]
    pub fn as_ptr(&self) -> *const u8 {
        self.0.as_ptr()
    }

    /// Returns the mutable pointer to the string.
    #[inline(always)]
    pub fn as_mut_ptr(&mut self) -> *mut u8 {
        self.0.as_ptr()
    }
}

/// Creates new StrPtr.
#[macro_export]
macro_rules! str_ptr {
    ($($s:expr),*) => {
        unsafe { $crate::types::StrPtr::new_unchecked(concat! { $($s),*, "\x00" }.as_bytes().as_ptr()) }
    };
}

/// Zero terminated UTF-16 string. Have the same layout as `*const u16`.
/// Used for convenience so it can be returned from extern funcs.
#[derive(Debug, Clone)]
#[repr(transparent)]
pub struct WidePtr(NonNull<u16>);
impl WidePtr {
    /// Converts pointer to string by cloning data.
    /// # Safety
    /// `WidePtr` must point to valid memory.
    #[inline]
    pub unsafe fn into_string(self) -> String {
        String::from_utf16_lossy(crate::terminated_array(self.0.as_ptr(), &0))
    }

    /// Creates new [`WidePtr`] from pointer without checking if it's null.
    /// # Safety
    /// `p` must not be `null`.
    #[inline(always)]
    pub const unsafe fn new_unchecked(p: *const u16) -> Self {
        Self(NonNull::new_unchecked(p as _))
    }

    /// Creates new [`WidePtr`] from pointer.
    #[inline(always)]
    pub fn new(p: *const u16) -> Option<Self> {
        Some(Self(NonNull::new(p as _)?))
    }

    /// Returns the pointer to the string.
    #[inline(always)]
    pub fn as_ptr(&self) -> *const u16 {
        self.0.as_ptr()
    }

    /// Returns the mutable pointer to the string.
    #[inline(always)]
    pub fn as_mut_ptr(&mut self) -> *mut u16 {
        self.0.as_ptr()
    }
}