Crate winver

source ·
Expand description

winver crate

CI crate docs

winver is a tiny Rust crate to detect real Windows OS version depending on windows crate only.

use winver::WindowsVersion;

let version = WindowsVersion::detect().unwrap();
if version >= WindowsVersion::new(10, 0, 15063) {
    println!("OS version is 10.0.15063 or later: {}", version);
}

There are several ways to get Windows OS version and each of them has its pitfall. This crate provides API to get the version more easily and safely avoiding the pitfalls.

The above WindowsVersion::detect function works as follows:

  1. Try to get OS version from RtlGetVersion function in ntdll.dll. However it is a kernel mode function and ntdll.dll does not always exist.
  2. Try to get OS version from WMI’s Win32_OperatingSystem provider via WQL. WMI may not be available due to the process security level setting.
  3. Try to get OS version from a file version information of kernel32.dll. However the version information in file might be slightly different from the actual OS version.
  4. Try to get OS version from GetVersionExW function as fallback. This is an official way to get OS version but it lies if the program is running in compatibility mode and it requires to embed compatibility manifest in your executable.
  5. Give up getting OS version and return None.

Each steps are implemented as isolated funcitons in WindowsVersion. For example, the step 1. is equivalent to WindowsVersion::from_ntdll_dll.

This logic was implemented referring to the implementation of Python’s sys.getwindowsversion and platform.win32_ver.

See the API documentation for more details.

Installation

Add the following lines to your project’s Cargo.toml. Note that winver crate is available only on Windows.

[target."cfg(windows)".dependencies]
winver = "1"

Minimum supported Rust version is 1.65.0 for using let-else statement.

License

Distributed under the MIT license.

Structs

  • The single error type for all errors returned from this crate.
  • Windows OS version.