chore!: bump to Rust 2024 Edition (#430)

Signed-off-by: Leon Durrenberger <[email protected]>
Co-authored-by: leon-xd <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

CONTRIBUTING.md

@@ -87,9 +87,10 @@ That's it! Thank you for your contribution!
 
 The following tools should be installed as a part of the `windows-drivers-rs` developer workflow:
 
-* `cargo-expand`: `cargo install --locked cargo-expand --version 1.0.85`
 * `cargo-audit`: `cargo install --locked cargo-audit`
+* `cargo-expand`: `cargo install --locked cargo-expand --version 1.0.85`
 * `cargo-machete`: `cargo install --locked cargo-machete`
+* `cargo-sort`: `cargo install --locked cargo-sort`
 * `taplo-cli`: `cargo install --locked taplo-cli`
 * `typos-cli`: `cargo install --locked typos-cli`
 

Cargo.toml

@@ -15,8 +15,8 @@ exclude = [
 resolver = "3"
 
 [workspace.package]
-edition = "2021"
-rust-version = "1.84.0"
+edition = "2024"
+rust-version = "1.85.0"
 repository = "https://github.com/microsoft/windows-drivers-rs"
 readme = "README.md"
 license = "MIT OR Apache-2.0"

README.md

@@ -127,7 +127,9 @@ The crates in this repository are available from [`crates.io`](https://crates.io
       PCUNICODE_STRING,
    };
 
-   #[export_name = "DriverEntry"] // WDF expects a symbol with the name DriverEntry
+   // SAFETY: "DriverEntry" is the required symbol name for Windows driver entry points.
+   // No other function in this compilation unit exports this name, preventing symbol conflicts.
+   #[unsafe(export_name = "DriverEntry")] // WDF expects a symbol with the name DriverEntry
    pub unsafe extern "system" fn driver_entry(
       driver: PDRIVER_OBJECT,
       registry_path: PCUNICODE_STRING,

crates/cargo-wdk/src/actions/build/build_task.rs

@@ -14,7 +14,7 @@ use tracing::debug;
 #[double]
 use crate::providers::exec::CommandExec;
 use crate::{
-    actions::{build::error::BuildTaskError, to_target_triple, Profile, TargetArch},
+    actions::{Profile, TargetArch, build::error::BuildTaskError, to_target_triple},
     trace,
 };
 

crates/cargo-wdk/src/actions/build/mod.rs

@@ -13,7 +13,7 @@ mod package_task;
 #[cfg(test)]
 mod tests;
 use std::{
-    path::{absolute, Path, PathBuf},
+    path::{Path, PathBuf, absolute},
     result::Result::Ok,
 };
 
@@ -26,7 +26,7 @@ use package_task::{PackageTask, PackageTaskParams};
 use tracing::{debug, error as err, info, warn};
 use wdk_build::metadata::{TryFromCargoMetadataError, Wdk};
 
-use crate::actions::{to_target_triple, Profile, TargetArch};
+use crate::actions::{Profile, TargetArch, to_target_triple};
 #[double]
 use crate::providers::{exec::CommandExec, fs::Fs, metadata::Metadata, wdk_build::WdkBuild};
 

crates/cargo-wdk/src/actions/build/tests.rs

@@ -14,9 +14,9 @@ use cargo_metadata::Metadata as CargoMetadata;
 use mockall::predicate::eq;
 use mockall_double::double;
 use wdk_build::{
-    metadata::{TryFromCargoMetadataError, Wdk},
     CpuArchitecture,
     DriverConfig,
+    metadata::{TryFromCargoMetadataError, Wdk},
 };
 
 #[double]
@@ -28,10 +28,10 @@ use crate::providers::{
 };
 use crate::{
     actions::{
-        build::{BuildAction, BuildActionError, BuildActionParams},
-        to_target_triple,
         Profile,
         TargetArch,
+        build::{BuildAction, BuildActionError, BuildActionParams},
+        to_target_triple,
     },
     providers::error::{CommandError, FileError},
 };
@@ -139,8 +139,8 @@ pub fn given_a_driver_project_when_target_arch_is_arm64_then_it_builds_successfu
 }
 
 #[test]
-pub fn given_a_driver_project_when_profile_is_release_and_target_arch_is_arm64_then_it_builds_successfully(
-) {
+pub fn given_a_driver_project_when_profile_is_release_and_target_arch_is_arm64_then_it_builds_successfully()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = Some(Profile::Release);
@@ -781,8 +781,8 @@ pub fn given_a_driver_project_when_infverif_command_execution_fails_then_package
 }
 
 #[test]
-pub fn given_a_non_driver_project_when_default_values_are_provided_with_no_wdk_metadata_are_provided_then_build_should_be_successful(
-) {
+pub fn given_a_non_driver_project_when_default_values_are_provided_with_no_wdk_metadata_are_provided_then_build_should_be_successful()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -811,8 +811,8 @@ pub fn given_a_non_driver_project_when_default_values_are_provided_with_no_wdk_m
 }
 
 #[test]
-pub fn given_a_invalid_driver_project_with_partial_wdk_metadata_when_valid_default_values_are_provided_then_wdk_metadata_parse_should_fail(
-) {
+pub fn given_a_invalid_driver_project_with_partial_wdk_metadata_when_valid_default_values_are_provided_then_wdk_metadata_parse_should_fail()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp\\sample-driver");
     let profile = None;
@@ -851,8 +851,8 @@ pub fn given_a_invalid_driver_project_with_partial_wdk_metadata_when_valid_defau
 /// Workspace tests
 ////////////////////////////////////////////////////////////////////////////////
 #[test]
-pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_default_values_are_provided_then_it_packages_successfully(
-) {
+pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_default_values_are_provided_then_it_packages_successfully()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -923,8 +923,8 @@ pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_defau
 }
 
 #[test]
-pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_is_driver_project_then_it_packages_driver_project_successfully(
-) {
+pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_is_driver_project_then_it_packages_driver_project_successfully()
+ {
     // Input CLI args
     let workspace_root_dir = PathBuf::from("C:\\tmp");
     let cwd = workspace_root_dir.join("sample-kmdf-1");
@@ -1011,8 +1011,8 @@ pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_i
 }
 
 #[test]
-pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_verify_signature_is_false_then_it_skips_verify_tasks(
-) {
+pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_verify_signature_is_false_then_it_skips_verify_tasks()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -1083,8 +1083,8 @@ pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_verif
 }
 
 #[test]
-pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_is_non_driver_project_then_it_builds_but_skips_packaging(
-) {
+pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_is_non_driver_project_then_it_builds_but_skips_packaging()
+ {
     // Input CLI args
     let workspace_root_dir = PathBuf::from("C:\\tmp");
     let cwd = workspace_root_dir.join("non-driver");
@@ -1147,8 +1147,8 @@ pub fn given_a_workspace_with_multiple_driver_and_non_driver_projects_when_cwd_i
 }
 
 #[test]
-pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_each_workspace_member_level_when_default_values_are_provided_then_wdk_metadata_parse_should_fail(
-) {
+pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_each_workspace_member_level_when_default_values_are_provided_then_wdk_metadata_parse_should_fail()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -1214,8 +1214,8 @@ pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_each_works
 }
 
 #[test]
-pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_root_and_workspace_member_level_when_default_values_are_provided_then_wdk_metadata_parse_should_fail(
-) {
+pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_root_and_workspace_member_level_when_default_values_are_provided_then_wdk_metadata_parse_should_fail()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -1281,8 +1281,8 @@ pub fn given_a_workspace_with_multiple_distinct_wdk_configurations_at_root_and_w
 }
 
 #[test]
-pub fn given_a_workspace_only_with_non_driver_projects_when_cwd_is_workspace_root_then_build_should_be_successful(
-) {
+pub fn given_a_workspace_only_with_non_driver_projects_when_cwd_is_workspace_root_then_build_should_be_successful()
+ {
     // Input CLI args
     let cwd = PathBuf::from("C:\\tmp");
     let profile = None;
@@ -1318,8 +1318,8 @@ pub fn given_a_workspace_only_with_non_driver_projects_when_cwd_is_workspace_roo
 }
 
 #[test]
-pub fn given_a_workspace_only_with_non_driver_projects_when_cwd_is_workspace_member_then_build_should_be_successful(
-) {
+pub fn given_a_workspace_only_with_non_driver_projects_when_cwd_is_workspace_member_then_build_should_be_successful()
+ {
     // Input CLI args
     let workspace_root_dir = PathBuf::from("C:\\tmp");
     let cwd = workspace_root_dir.join("non-driver");
@@ -1727,7 +1727,7 @@ impl TestBuildAction {
             &manifest_path,
         ]
         .into_iter()
-        .map(std::string::ToString::to_string)
+        .map(ToString::to_string)
         .collect();
         if let Some(profile) = self.profile {
             expected_cargo_build_args.push("--profile".to_string());

crates/cargo-wdk/src/actions/new/mod.rs

@@ -15,7 +15,7 @@ use std::{
 
 use clap_verbosity_flag::Verbosity;
 use error::NewActionError;
-use include_dir::{include_dir, Dir};
+use include_dir::{Dir, include_dir};
 use mockall_double::double;
 use tracing::{debug, info};
 

crates/cargo-wdk/src/cli.rs

@@ -12,14 +12,14 @@ use mockall_double::double;
 use wdk_build::CpuArchitecture;
 
 use crate::actions::{
-    build::{BuildAction, BuildActionParams},
-    new::NewAction,
     DriverType,
+    KMDF_STR,
     Profile,
     TargetArch,
-    KMDF_STR,
     UMDF_STR,
     WDM_STR,
+    build::{BuildAction, BuildActionParams},
+    new::NewAction,
 };
 #[double]
 use crate::providers::{exec::CommandExec, fs::Fs, metadata::Metadata, wdk_build::WdkBuild};

crates/cargo-wdk/src/providers/fs.rs

@@ -11,7 +11,7 @@
 #![allow(clippy::unused_self)]
 
 use std::{
-    fs::{copy, create_dir, read_dir, rename, DirEntry, File, FileType, OpenOptions},
+    fs::{DirEntry, File, FileType, OpenOptions, copy, create_dir, read_dir, rename},
     io::{Read, Write},
     path::Path,
 };

crates/cargo-wdk/src/test_utils.rs

@@ -39,9 +39,9 @@ where
 
         // Remove the env var if value is None
         if let Some(value) = value {
-            std::env::set_var(key, value);
+            set_var(key, value);
         } else {
-            std::env::remove_var(key);
+            remove_var(key);
         }
     }
 
@@ -51,13 +51,83 @@ where
     for (key, _) in env_vars_key_value_pairs {
         original_env_vars.get(key).map_or_else(
             || {
-                std::env::remove_var(key);
+                remove_var(key);
             },
             |value| {
-                std::env::set_var(key, value);
+                set_var(key, value);
             },
         );
     }
 
     f_return_value
 }
+
+/// Safely sets an environment variable. Will not compile if crate is not
+/// targeted for Windows.
+///
+/// This function provides a safe wrapper around [`std::env::set_var`] that
+/// became unsafe in Rust 2024 edition.
+///
+/// # Panics
+///
+/// This function may panic if key is empty, contains an ASCII equals sign '='
+/// or the NUL character '\0', or when value contains the NUL character.
+#[cfg(target_os = "windows")]
+pub fn set_var<K, V>(key: K, value: V)
+where
+    K: AsRef<OsStr>,
+    V: AsRef<OsStr>,
+{
+    // SAFETY: this function is only conditionally compiled for windows targets, and
+    // env::set_var is always safe for windows targets
+    unsafe {
+        std::env::set_var(key, value);
+    }
+}
+
+#[cfg(not(target_os = "windows"))]
+pub fn set_var<K, V>(_key: K, _value: V)
+where
+    K: AsRef<OsStr>,
+    V: AsRef<OsStr>,
+{
+    compile_error!(
+        "windows-drivers-rs is designed to be run on a Windows host machine in a WDK environment. \
+         Please build using a Windows target."
+    );
+}
+
+/// Safely removes an environment variable. Will not compile if crate is not
+/// targeted for Windows.
+///
+/// This function provides a safe wrapper around [`std::env::remove_var`] that
+/// became unsafe in Rust 2024 edition.
+///
+/// # Panics
+///
+/// This function may panic if key is empty, contains an ASCII equals sign '='
+/// or the NUL character '\0', or when value contains the NUL character.
+#[allow(dead_code)]
+#[cfg(target_os = "windows")]
+pub fn remove_var<K>(key: K)
+where
+    K: AsRef<OsStr>,
+{
+    // SAFETY: this function is only conditionally compiled for windows targets, and
+    // env::remove_var is always safe for windows targets
+    unsafe {
+        std::env::remove_var(key);
+    }
+}
+
+#[allow(dead_code)]
+#[cfg(not(target_os = "windows"))]
+pub fn remove_var<K>(_key: K)
+where
+    K: AsRef<OsStr>,
+{
+    compile_error!(
+        "windows-drivers-rs is designed to be run on a Windows host machine in a WDK environment. \
+         Please build using a Windows target."
+    );
+}