Struct tugger_wix::WiXInstallerBuilder

pub struct WiXInstallerBuilder { /* private fields */ }

Entity used to build installers using the WiX Toolkit.

Implementations

impl WiXInstallerBuilder

pub fn new<P: AsRef<Path>>(id_prefix: String, arch: String, build_path: P) -> Self

Create a new instance.

pub fn arch(&self) -> &str

The WiX architecture of the installer we’re building.

pub fn set_arch(&mut self, value: impl ToString)

Set the WiX architecture of the installer we’re building.

pub fn variables(&self) -> Iter<'_, String, Option<String>>

Obtain variables that will be used for light invocations.

pub fn set_variable<S: ToString>(&mut self, key: S, value: Option<S>)

Set a WiX variable with an optional value.

These are passed to light.exe.

pub fn set_build_path(&mut self, path: impl AsRef<Path>)

Set the directory to use to build the installer in.

pub fn build_path(&self) -> &Path

Obtain the directory to use for building the installer.

pub fn wxs_files(&self) -> &BTreeMap<PathBuf, WxsBuilder>

pub fn add_wxs(&mut self, wxs: WxsBuilder)

Add a wxs file to build.

pub fn add_extra_build_file<P: AsRef<Path>>(
    &mut self,
    path: P,
    content: impl Into<FileEntry>
) -> Result<()>

Add an extra file to the build environment.

These files will be materialized next to .wxs files.

pub fn add_extra_build_files(&mut self, manifest: &FileManifest) -> Result<()>

Add additional files to be materialized in the build environment.

Files are specified via a FileManifest and will be materialized next to .wxs files.

pub fn install_files(&self) -> &FileManifest

pub fn install_files_mut(&mut self) -> &mut FileManifest

pub fn install_files_wxs_path(&self) -> &Path

The path that the auto-generated wxs file for Self::install_files will be materialized in.

Default is install-files.wxs.

pub fn set_install_files_wxs_path(&mut self, path: impl AsRef<Path>)

Set the path that the auto-generated wxs file for Self::install_files will be materialized in.

pub fn install_files_root_directory_id(&self) -> &str

The <Directory Id= value that the autogenerated <DirectoryRef> for Self::install_files will refer to.

This essentially defines how to map our autogenerated wxs file containing fragments for Self::install_files to an install location.

The default value is APPLICATIONFOLDER. You may need to change this value if your <Directory> corresponding to the root installation directory has a different Id value.

pub fn set_install_files_root_directory_id(&mut self, value: impl ToString)

Set the <Directory Id= that the root of Self::install_files will point to.

See Self::install_files_root_directory_id for more on this functionality.

pub fn auto_sign_signtool(&mut self, settings: SigntoolSign)

Register signtool signing settings to be used to automatically sign binaries.

This will automatically sign all installed binaries as well as the generated installer.

pub fn add_files_manifest_wxs(&mut self) -> Result<()>

Generate a wxs file containing fragments for all files registered for install.

This will take the current Self::install_files manifest and produce a WiX XML file containing <Fragment> and <DirectoryRef> for the contents of that manifest. The WXS file will be registered for building.

pub fn build<P: AsRef<Path>>(&self, output_path: P) -> Result<()>

Produce an installer using the configuration in this builder.

The output could be an MSI, exe, or other file formats depending on what the wxs files define.