embed-resource

In your build.rs script, use embed_resource::compile to process a resource file (.rc).

Use .manifest_optional().unwrap() if the manifest is cosmetic (e.g., an icon). Use .manifest_required().unwrap() if the manifest is required for security or as an entry point.

Arguments that look like &["string"] or embed_resource::NONE must satisfy IntoIterator<AsRef<OsStr>> (e.g., &[&str], Option<PathBuf>, or Vec<OsString>).

extern crate embed_resource;

fn main() {
    // Compile and link checksums.rc
    embed_resource::compile("checksums.rc", embed_resource::NONE).manifest_optional().unwrap();

    // Or, to select a resource file for each binary separately
    embed_resource::compile_for("assets/poke-a-mango.rc", &["poke-a-mango", "poke-a-mango-installer"], &["VERSION=\"0.5.0\""]).manifest_required().unwrap();
    embed_resource::compile_for("assets/uninstaller.rc", &["unins001"], embed_resource::NONE).manifest_required().unwrap();
}

To embed Windows resources (like icons or manifests) into your application, use embed_resource within your build.rs file.

1. Setup Cargo.toml

Add embed-resource to your [build-dependencies]:

[build-dependencies]
embed-resource = "3.0"

2. Implement build.rs

Use embed_resource::compile() to process your .rc file. You must decide if the resulting manifest is optional or required using .manifest_optional() or .manifest_required().

• Use .manifest_optional() for cosmetic resources like icons.
• Use .manifest_required() for critical resources like security settings or entry points.

Note: In version 3.x, these methods are #[must_use], so you should call .unwrap() or handle the result to ensure compilation errors are caught.

extern crate embed_resource;

fn main() {
    // Basic usage with no extra parameters
    embed_resource::compile("checksums.rc", embed_resource::NONE).manifest_optional().unwrap();

    // Usage with macro definitions
    embed_resource::compile("checksums.rc", &["VERSION=000901"]).manifest_required().unwrap();

    // Usage with macros and include directories
    embed_resource::compile("checksums.rc", embed_resource::ParamsMacrosAndIncludeDirs(
        &["VERSION=000901"], 
        &["src/include"]
    )).manifest_required().unwrap();
}

To embed a manifest that requests administrator privileges, follow these steps:

1. Add embed-resource = "3.0" to [build-dependencies] in Cargo.toml.
2. Create build.rs in your project root:

   extern crate embed_resource;
   fn main() {
       embed_resource::compile("app-name-manifest.rc", embed_resource::NONE).manifest_optional().unwrap();
   }

3. Create app-name-manifest.rc in your project root:

   #define RT_MANIFEST 24
   1 RT_MANIFEST "app-name.exe.manifest"

4. Create app-name.exe.manifest in your project root:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
       <trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
           <security>
               <requestedPrivileges>
                   <requestedExecutionLevel level="requireAdministrator" uiAccess="false"/>
               </requestedPrivileges>
           </security>
       </trustInfo>
   </assembly>

5. Build your project.

If you want to avoid linking the resource to every single artifact in your crate, use the specialized compile_for* functions. These are useful for large projects where you only want specific binaries to carry the Windows resources.

Available Functions

• compile_for(resource_file, for_bins, parameters): Links the resource to a specific list of binary names (available since rustc 1.55.0).
• compile_for_tests(resource_file, parameters): Links to test binaries (available since rustc 1.60.0).
• compile_for_benchmarks(resource_file, parameters): Links to benchmark binaries (available since rustc 1.60.0).
• compile_for_examples(resource_file, parameters): Links to example binaries (available since rustc 1.60.0).
• compile_for_cdylib(resource_file, parameters): Links to the cdylib (available since rustc 1.61.0).
• compile_for_everything(resource_file, parameters): Links to every artifact (available since rustc 1.50.0).

// Link to specific binaries
embed_resource::compile_for(
    "assets/poke-a-mango.rc", 
    &["poke-a-mango", "poke-a-mango-installer"], 
    &["VERSION=\"0.5.0\""]
);

// Link to everything
embed_resource::compile_for_everything("res.rc", embed_resource::NONE);