#build #manifest #windows

embed-manifest

Build script library to easily embed a Windows manifest

5 stable releases

Uses new Rust 2021

1.3.0 May 1, 2022
1.2.1 Apr 18, 2022
1.2.0 Apr 17, 2022
1.1.0 Mar 25, 2022
1.0.0 Dec 18, 2021

#67 in Build Utils

Download history 2/week @ 2022-01-27 1/week @ 2022-02-03 2/week @ 2022-02-17 3/week @ 2022-03-10 6/week @ 2022-03-17 22/week @ 2022-03-24 4/week @ 2022-03-31 3/week @ 2022-04-07 40/week @ 2022-04-14 8/week @ 2022-04-21 55/week @ 2022-04-28 40/week @ 2022-05-05 83/week @ 2022-05-12

192 downloads per month

MIT license

69KB
1K SLoC

Windows Manifest Embedding for Rust

The embed-manifest crate provides a straightforward way to embed a Windows manifest in an executable, whatever the build environment, without dependencies on external tools from LLVM or MinGW.

If you need to embed more resources than just a manifest, you may find the winres or embed-resource crates more suitable. They have additional dependencies and setup requirements that may make them a little more difficult to use, though.

Why use it?

The Rust compiler doesn’t add a manifest to a Windows executable, which means that it runs with a few compatibility options and settings that make it look like the program is running on an older version of Windows. By adding an application manifest using this crate, even when cross-compiling:

  • 32-bit programs with names that look like installers don’t try to run as an administrator.
  • 32-bit programs aren’t shown a virtualised view of the filesystem and registry.
  • Many non-Unicode APIs accept UTF-8 strings, the same as Rust uses.
  • The program sees the real Windows version, not Windows Vista.
  • Built-in message boxes and other UI elements can display without blurring on high-DPI monitors.
  • Other features like long path names in APIs can be enabled.

Usage

To embed a default manifest, include this code in a build.rs build script:

use embed_manifest::{embed_manifest, new_manifest};

fn main() {
    if std::env::var_os("CARGO_CFG_WINDOWS").is_some() {
        embed_manifest(new_manifest("Contoso.Sample"))
            .expect("unable to embed manifest file");
    }
    println!("cargo:rerun-if-changed=build.rs");
}

See the crate documentation for information about how to customise the embedded manifest.

License

For the avoidance of doubt, while this crate itself is licensed to you under the MIT License, this does not affect the copyright status and licensing of your own code when this is used from a Cargo build script.

No runtime deps