Struct WixConfig

pub struct WixConfig {

    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>,
}

Configuration for the MSI bundle using WiX.

See more: https://v2.tauri.app/reference/config/#wixconfig

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 Config::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 foruth 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, run 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 installer languages to build. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables.

template: Option<PathBuf>

A custom .wxs template to use.

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.

Trait Implementations

impl Clone for WixConfig

fn clone(&self) -> WixConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WixConfig

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

Formats the value using the given formatter.

impl Default for WixConfig

fn default() -> WixConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WixConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WixConfig

fn eq(&self, other: &WixConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WixConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WixConfig

impl StructuralPartialEq for WixConfig