Struct cargo_packager::config::WixConfig

#[non_exhaustive]
pub struct WixConfig {

    pub languages: Option<Vec<WixLanguage>>,
    pub template: Option<PathBuf>,
    pub merge_modules: Option<Vec<PathBuf>>,
    pub fragment_paths: Option<Vec<PathBuf>>,
    pub fragments: Option<Vec<String>>,
    pub component_group_refs: Option<Vec<String>>,
    pub component_refs: Option<Vec<String>>,
    pub custom_action_refs: Option<Vec<String>>,
    pub feature_group_refs: Option<Vec<String>>,
    pub feature_refs: Option<Vec<String>>,
    pub merge_refs: Option<Vec<String>>,
    pub banner_path: Option<PathBuf>,
    pub dialog_image_path: Option<PathBuf>,
    pub fips_compliant: bool,
}

The wix format configuration

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

languages: Option<Vec<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 packager uses an internal template. This option allows you to define your own wix file.

merge_modules: Option<Vec<PathBuf>>

List of merge modules to include in your installer. For example, if you want to include C++ Redis merge modules

fragment_paths: Option<Vec<PathBuf>>

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

fragments: Option<Vec<String>>

List of WiX fragments as strings. This is similar to config.wix.fragments_paths but is a string so you can define it inline in your config.

<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Fragment>
    <CustomAction Id="OpenNotepad" Directory="INSTALLDIR" Execute="immediate" ExeCommand="cmd.exe /c notepad.exe" Return="check" />
    <InstallExecuteSequence>
        <Custom Action="OpenNotepad" After="InstallInitialize" />
    </InstallExecuteSequence>
</Fragment>
</Wix>

component_group_refs: Option<Vec<String>>

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

component_refs: Option<Vec<String>>

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

custom_action_refs: Option<Vec<String>>

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

feature_group_refs: Option<Vec<String>>

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

feature_refs: Option<Vec<String>>

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

merge_refs: Option<Vec<String>>

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

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.

Implementations

impl WixConfig

pub fn new() -> Self

Creates a new WixConfig.

pub fn languages<I: IntoIterator<Item = WixLanguage>>( self, languages: I ) -> Self

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

pub fn template<P: Into<PathBuf>>(self, template: P) -> Self

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

pub fn merge_modules<I, P>(self, merge_modules: I) -> Self

where I: IntoIterator<Item = P>, P: Into<PathBuf>,

Set a list of merge modules to include in your installer. For example, if you want to include C++ Redis merge modules

pub fn fragment_paths<I, S>(self, fragment_paths: I) -> Self

where I: IntoIterator<Item = S>, S: Into<PathBuf>,

Set a list of paths to .wxs files with WiX fragments to use.

pub fn fragments<I, S>(self, fragments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set a list of WiX fragments as strings. This is similar to WixConfig::fragment_paths but is a string so you can define it inline in your config.

<?xml version="1.0" encoding="utf-8"?>
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Fragment>
    <CustomAction Id="OpenNotepad" Directory="INSTALLDIR" Execute="immediate" ExeCommand="cmd.exe /c notepad.exe" Return="check" />
    <InstallExecuteSequence>
        <Custom Action="OpenNotepad" After="InstallInitialize" />
    </InstallExecuteSequence>
</Fragment>
</Wix>

pub fn component_group_refs<I, S>(self, component_group_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

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

pub fn component_refs<I, S>(self, component_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

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

pub fn custom_action_refs<I, S>(self, custom_action_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the CustomAction element ids you want to reference from the fragments.

pub fn feature_group_refs<I, S>(self, feature_group_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set he FeatureGroup element ids you want to reference from the fragments.

pub fn feature_refs<I, S>(self, feature_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

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

pub fn merge_refs<I, S>(self, merge_refs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set he Merge element ids you want to reference from the fragments.

pub fn banner_path<P: Into<PathBuf>>(self, path: P) -> Self

Set the 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.

pub fn dialog_image_path<P: Into<PathBuf>>(self, path: P) -> Self

Set the 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.

pub fn fips_compliant(self, fips_compliant: bool) -> Self

Set whether to enable or disable FIPS compliant algorithms.

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 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.