Struct WixSettings

pub struct WixSettings {

    pub version: Option<String>,
    pub upgrade_code: Option<Uuid>,
    pub language: WixLanguage,
    pub template: Option<PathBuf>,
    pub fragment_paths: Vec<PathBuf>,
    pub component_group_refs: Vec<String>,
    pub component_refs: Vec<String>,
    pub feature_group_refs: Vec<String>,
    pub feature_refs: Vec<String>,
    pub merge_refs: Vec<String>,
    pub enable_elevated_update_task: bool,
    pub banner_path: Option<PathBuf>,
    pub dialog_image_path: Option<PathBuf>,
    pub fips_compliant: bool,
}

Settings specific to the WiX implementation.

Fields

version: Option<String>

MSI installer version in the format major.minor.patch.build (build is optional).

Because a valid version is required for MSI installer, it will be derived from PackageSettings::version if this field is not set.

The first field is the major version and has a maximum value of 255. The second field is the minor version and has a maximum value of 255. The third and fourth fields have a maximum value of 65,535.

See https://learn.microsoft.com/en-us/windows/win32/msi/productversion for more info.

upgrade_code: Option<Uuid>

A GUID upgrade code for MSI installer. This code must stay the same across all of your updates, otherwise, Windows will treat your update as a different app and your users will have duplicate versions of your app.

By default, tauri generates this code by generating a Uuid v5 using the string <productName>.exe.app.x64 in the DNS namespace. You can use Tauri’s CLI to generate and print this code for you by running tauri inspect wix-upgrade-code.

It is recommended that you set this value in your tauri config file to avoid accidental changes in your upgrade code whenever you want to change your product name.

language: WixLanguage

The app languages to build. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables.

template: Option<PathBuf>

By default, the bundler uses an internal template. This option allows you to define your own wix file.

fragment_paths: Vec<PathBuf>

A list of paths to .wxs files with WiX fragments to use.

component_group_refs: Vec<String>

The ComponentGroup element ids you want to reference from the fragments.

component_refs: Vec<String>

The Component element ids you want to reference from the fragments.

feature_group_refs: Vec<String>

The FeatureGroup element ids you want to reference from the fragments.

feature_refs: Vec<String>

The Feature element ids you want to reference from the fragments.

merge_refs: Vec<String>

The Merge element ids you want to reference from the fragments.

enable_elevated_update_task: bool

Create an elevated update task within Windows Task Scheduler.

banner_path: Option<PathBuf>

Path to a bitmap file to use as the installation user interface banner. This bitmap will appear at the top of all but the first page of the installer.

The required dimensions are 493px × 58px.

dialog_image_path: Option<PathBuf>

Path to a bitmap file to use on the installation user interface dialogs. It is used on the welcome and completion dialogs. The required dimensions are 493px × 312px.

fips_compliant: bool

Enables FIPS compliant algorithms.

Trait Implementations

impl Clone for WixSettings

fn clone(&self) -> WixSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WixSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WixSettings

fn default() -> WixSettings

Returns the “default value” for a type.