feat: add more precise NTSTATUS const fns (#183)

Author: NateD-MSFT

Cargo.toml

@@ -10,6 +10,7 @@ exclude = [
   "tests/config-umdf",
   "tests/config-wdm",
   "tests/wdk-macros-tests",
+  "tests/wdk-sys-tests",
 ]
 resolver = "2"
 

crates/wdk-sys/src/lib.rs

@@ -74,13 +74,72 @@ pub extern "system" fn __CxxFrameHandler3() -> i32 {
     driver_model__driver_type = "KMDF",
     driver_model__driver_type = "UMDF"
 ))]
-#[allow(missing_docs)]
 #[must_use]
 #[allow(non_snake_case)]
+/// Evaluates to TRUE if the return value specified by `nt_status` is a success
+/// type (0 − 0x3FFFFFFF) or an informational type (0x40000000 − 0x7FFFFFFF).
+/// This function is taken from ntdef.h in the WDK.
+///
+/// See the [NTSTATUS reference](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) and
+/// [Using NTSTATUS values](https://learn.microsoft.com/en-us/windows-hardware/drivers/kernel/using-ntstatus-values) for details.
 pub const fn NT_SUCCESS(nt_status: NTSTATUS) -> bool {
     nt_status >= 0
 }
 
+#[cfg(any(
+    driver_model__driver_type = "WDM",
+    driver_model__driver_type = "KMDF",
+    driver_model__driver_type = "UMDF"
+))]
+#[must_use]
+#[allow(non_snake_case)]
+#[allow(clippy::cast_sign_loss)]
+/// Evaluates to TRUE if the return value specified by `nt_status` is an
+/// informational type (0x40000000 − 0x7FFFFFFF). This function is taken from
+/// ntdef.h in the WDK.
+///
+/// See the [NTSTATUS reference](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) and
+/// [Using NTSTATUS values](https://learn.microsoft.com/en-us/windows-hardware/drivers/kernel/using-ntstatus-values) for details.
+pub const fn NT_INFORMATION(nt_status: NTSTATUS) -> bool {
+    (nt_status as u32 >> 30) == 1
+}
+
+#[cfg(any(
+    driver_model__driver_type = "WDM",
+    driver_model__driver_type = "KMDF",
+    driver_model__driver_type = "UMDF"
+))]
+#[must_use]
+#[allow(non_snake_case)]
+#[allow(clippy::cast_sign_loss)]
+/// Evaluates to TRUE if the return value specified by `nt_status` is a warning
+/// type (0x80000000 − 0xBFFFFFFF).  This function is taken from ntdef.h in the
+/// WDK.
+///
+/// See the [NTSTATUS reference](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) and
+/// [Using NTSTATUS values](https://learn.microsoft.com/en-us/windows-hardware/drivers/kernel/using-ntstatus-values) for details.
+pub const fn NT_WARNING(nt_status: NTSTATUS) -> bool {
+    (nt_status as u32 >> 30) == 2
+}
+
+#[cfg(any(
+    driver_model__driver_type = "WDM",
+    driver_model__driver_type = "KMDF",
+    driver_model__driver_type = "UMDF"
+))]
+#[must_use]
+#[allow(non_snake_case)]
+#[allow(clippy::cast_sign_loss)]
+/// Evaluates to TRUE if the return value specified by `nt_status` is an error
+/// type (0xC0000000 - 0xFFFFFFFF). This function is taken from ntdef.h in the
+/// WDK.
+///
+/// See the [NTSTATUS reference](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-erref/87fba13e-bf06-450e-83b1-9241dc81e781) and
+/// [Using NTSTATUS values](https://learn.microsoft.com/en-us/windows-hardware/drivers/kernel/using-ntstatus-values) for details.
+pub const fn NT_ERROR(nt_status: NTSTATUS) -> bool {
+    (nt_status as u32 >> 30) == 3
+}
+
 #[cfg(any(driver_model__driver_type = "WDM", driver_model__driver_type = "KMDF"))]
 #[allow(missing_docs)]
 #[macro_export]

tests/Makefile.toml

@@ -9,4 +9,5 @@ CARGO_MAKE_CRATE_WORKSPACE_MEMBERS = [
   "mixed-package-kmdf-workspace",
   "umdf-driver-workspace",
   "wdk-macros-tests",
+  "wdk-sys-tests",
 ]