windows-ext 0.0.4

Extensions to windows-rs that serve to provide the macros and header-only functions from the Windows SDK
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

//! This module provides extension traits that expose the freestanding functions
//! from [minwindef][crate::minwindef] directly on the respective types.
//!
//! These traits can also be used with [new-types](https://doc.rust-lang.org/rust-by-example/generics/new_types.html).

/// This trait provides the freestanding functions from [minwindef][crate::minwindef]
/// directly on WORDs ([u16]).
///
/// When using [new-types](https://doc.rust-lang.org/rust-by-example/generics/new_types.html) that wrap a WORD,
/// you can implement this trait by implementing the [value][WordExt::value] method.
///
/// This trait is included in the convenience wrapper [`windows_ext::ext`][crate::ext].
///
/// ```
/// use windows_ext::ext::WordExt; // or: windows_ext::minwindef::ext::DWordExt;
///
/// assert_eq!(0x12_34u16.hibyte(), 0x12);
/// assert_eq!(0x12_34u16.lobyte(), 0x34);
/// ```
pub trait WordExt: Copy {
    /// Provide the value of the WORD
    fn value(self) -> u16;

    /// Get the low order word as [u16]
    ///
    /// ```
    /// # use windows_ext::ext::WordExt;
    /// assert_eq!(0x12_34u16.lobyte(), 0x34);
    /// ```
    #[inline(always)]
    fn lobyte(self) -> u8 {
        super::lobyte(self.value())
    }

    /// Get the high order word as [u16]
    ///
    /// ```
    /// # use windows_ext::ext::WordExt;
    /// assert_eq!(0x12_34u16.hibyte(), 0x12);
    /// ```
    #[inline(always)]
    fn hibyte(self) -> u8 {
        super::hibyte(self.value())
    }

    /// Split a single dword into both of its words (lo, hi)
    ///
    /// ```
    /// # use windows_ext::ext::WordExt;
    /// assert_eq!(0x12_34u16.split(), (0x34, 0x12));
    /// ```
    #[inline(always)]
    fn split(self) -> (u8, u8) {
        super::splitword(self.value())
    }
}

impl WordExt for u16 {
    #[inline(always)]
    fn value(self) -> u16 {
        self as u16
    }
}

/// This trait provides the freestanding functions from [minwindef][crate::minwindef]
/// directly on DWORDs ([u32]).
///
/// When using [new-types](https://doc.rust-lang.org/rust-by-example/generics/new_types.html) that wrap a DWORD,
/// you can implement this trait by implementing the [value][DWordExt::value] method.
///
/// This trait is included in the convenience wrapper [`windows_ext::ext`][crate::ext].
///
/// ```
/// use windows_ext::ext::DWordExt; // or: windows_ext::minwindef::ext::DWordExt;
///
/// assert_eq!(0x1234_5678u32.hiword(), 0x1234);
/// assert_eq!(0x1234_5678u32.loword(), 0x5678);
/// ```
pub trait DWordExt: Copy {
    /// Gets the value of the DWORD.
    fn value(self) -> u32;

    /// Get the low order word as [u16]
    ///
    /// ```
    /// # use windows_ext::ext::DWordExt;
    /// assert_eq!(0x1234_5678u32.loword(), 0x5678);
    /// ```
    #[inline(always)]
    fn loword(self) -> u16 {
        super::loword(self.value())
    }

    /// Get the high order word as [u16]
    ///
    /// ```
    /// # use windows_ext::ext::DWordExt;
    /// assert_eq!(0x1234_5678u32.hiword(), 0x1234);
    /// ```
    #[inline(always)]
    fn hiword(self) -> u16 {
        super::hiword(self.value())
    }

    /// Split a single dword into both of its words (lo, hi)
    ///
    /// ```
    /// # use windows_ext::ext::DWordExt;
    /// assert_eq!(0x1234_5678u32.split(), (0x5678, 0x1234));
    /// ```
    #[inline(always)]
    fn split(self) -> (u16, u16) {
        super::splitdword(self.value())
    }
}

impl DWordExt for u32 {
    #[inline(always)]
    fn value(self) -> u32 {
        self
    }
}

impl DWordExt for usize {
    /// DWord value of a usize. On 64-bit this truncates to the lower 32.
    #[inline(always)]
    fn value(self) -> u32 {
        self as u32
    }
}

/// This trait provides the freestanding functions from [minwindef][crate::minwindef]
/// directly on QWORDs ([u64]).
///
/// When using [new-types](https://doc.rust-lang.org/rust-by-example/generics/new_types.html) that wrap a QWORD,
/// you can implement this trait by implementing the [value][QWordExt::value] method.
///
/// This trait is included in the convenience wrapper [`windows_ext::ext`][crate::ext].
///
/// ```
/// use windows_ext::ext::QWordExt; // or: windows_ext::minwindef::ext::QWordExt;
///
/// assert_eq!(0x1234_5678_9abc_def0u64.hidword(), 0x1234_5678);
/// assert_eq!(0x1234_5678_9abc_def0u64.lodword(), 0x9abc_def0);
/// ```
pub trait QWordExt: Copy {
    /// Gets the value of the QWORD.
    fn value(self) -> u64;

    /// Get the low order double word as [u32]
    ///
    /// ```
    /// # use windows_ext::ext::QWordExt;
    /// assert_eq!(0x1234_5678_9abc_def0u64.lodword(), 0x9abc_def0);
    /// ```
    #[inline(always)]
    fn lodword(self) -> u32 {
        super::lodword(self.value())
    }

    /// Get the high order double word as [u32]
    ///
    /// ```
    /// # use windows_ext::ext::QWordExt;
    /// assert_eq!(0x1234_5678_9abc_def0u64.hidword(), 0x1234_5678);
    /// ```
    #[inline(always)]
    fn hidword(self) -> u32 {
        super::hidword(self.value())
    }

    /// Split a single quad word into both of its double words (lo, hi)
    ///
    /// ```
    /// # use windows_ext::ext::QWordExt;
    /// assert_eq!(0x1234_5678_9abc_def0u64.split(), (0x9abc_def0, 0x1234_5678));
    /// ```
    #[inline(always)]
    fn split(self) -> (u32, u32) {
        super::splitqword(self.value())
    }
}

impl QWordExt for u64 {
    fn value(self) -> u64 {
        self
    }
}

impl QWordExt for usize {
    /// QWord for usize, on 32-bit this has normal padding semantics.
    fn value(self) -> u64 {
        self as u64
    }
}