registry 1.3.0

A safe wrapper for the Windows Registry API
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use std::{
    fmt::{Debug, Display},
    ptr::null_mut,
};

use utfx::{U16CString, U16String};
use windows::{core::PWSTR, Win32::{Foundation::ERROR_NO_MORE_ITEMS, System::Registry::{RegEnumKeyExW, RegQueryInfoKeyW}}};

use crate::key::RegKey;
use crate::sec::Security;

#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    #[error("Invalid UTF-16")]
    InvalidUtf16(#[from] std::string::FromUtf16Error),

    #[error("Missing null terminator in string")]
    MissingNul(#[from] utfx::MissingNulError<u16>),

    #[error("Invalid null found in string")]
    InvalidNul(#[from] utfx::NulError<u16>),
}

#[derive(Debug)]
pub struct Keys<'a> {
    regkey: &'a RegKey,
    buf: Vec<u16>,
    index: u32,
}

pub struct KeyRef<'a> {
    regkey: &'a RegKey,
    name: U16CString,
}

impl Display for KeyRef<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(&self.name.to_string_lossy())
    }
}

impl<'a> Debug for KeyRef<'a> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("KeyRef")
            .field(&self.name.to_string_lossy())
            .finish()
    }
}

impl<'a> KeyRef<'a> {
    #[inline]
    pub fn open(&self, sec: Security) -> Result<RegKey, crate::key::Error> {
        let path = self.regkey.path.to_ustring();
        let suffix = self.name.to_ustring();
        let bs = U16String::from_str("\\");
        let chars = path
            .as_slice()
            .iter()
            .chain(bs.as_slice())
            .chain(suffix.as_slice())
            .copied()
            .collect::<Vec<u16>>();

        let path = U16CString::new(chars)?;
        crate::key::open_hkey(self.regkey.handle, &self.name, sec).map(|handle| RegKey {
            hive: self.regkey.hive,
            handle,
            path,
        })
    }
}

impl<'a> Iterator for Keys<'a> {
    type Item = Result<KeyRef<'a>, Error>;

    fn next(&mut self) -> Option<Self::Item> {
        // Reset first byte, just in case.
        self.buf[0] = 0;
        let mut len = self.buf.len() as u32;

        let result = unsafe {
            RegEnumKeyExW(
                self.regkey.handle,
                self.index,
                PWSTR(self.buf.as_mut_ptr()),
                &mut len,
                None,
                PWSTR(null_mut()),
                None,
                None,
            )
        };

        if result == ERROR_NO_MORE_ITEMS {
            return None;
        }

        self.index += 1;

        if result.is_err() {
            // TODO: don't panic
            panic!();
        }

        let name = match U16CString::new(&self.buf[0..len as usize]) {
            Ok(v) => v,
            Err(e) => return Some(Err(Error::InvalidNul(e))),
        };

        Some(Ok(KeyRef {
            regkey: self.regkey,
            name,
        }))
    }
}

impl<'a> Keys<'a> {
    pub fn new(regkey: &'a RegKey) -> Result<Keys<'a>, std::io::Error> {
        let mut subkeys_max_str_len = 0u32;
        // let mut subkeys_len = 0u32;

        let result = unsafe {
            RegQueryInfoKeyW(
                regkey.handle,
                PWSTR(null_mut()),
                None,
                None,
                None, // &mut subkeys_len,
                Some(&mut subkeys_max_str_len),
                None,
                None,
                None,
                None,
                None,
                None,
            )
        };

        if result.is_ok() {
            return Ok(Keys {
                regkey,
                buf: vec![0u16; subkeys_max_str_len as usize + 1],
                index: 0,
            });
        }
        else {
            return Err(std::io::Error::from_raw_os_error(result.0 as i32));
        }
    }
}