Struct tugger_wix::WiXSimpleMsiBuilder
source · pub struct WiXSimpleMsiBuilder { /* private fields */ }
Expand description
Entity used to emit a simple .wxs
for building an msi installer.
Instances are constructed with mandatory fields, such as the product name, version, and author.
Various optional fields can be provided and will be used in the installer if provided.
The MSI installer will materialize registered files in the
Program Files
directory on the target machine.
Implementations§
source§impl WiXSimpleMsiBuilder
impl WiXSimpleMsiBuilder
pub fn new(
id_prefix: &str,
product_name: &str,
version: &str,
manufacturer: &str
) -> Self
sourcepub fn add_program_files_manifest(
&mut self,
manifest: &FileManifest
) -> Result<()>
pub fn add_program_files_manifest(
&mut self,
manifest: &FileManifest
) -> Result<()>
Add files to install to Program Files
via a FileManifest
.
All files in the provided manifest will be materialized in Program Files
by the built installer.
sourcepub fn add_visual_cpp_redistributable(
&mut self,
redist_version: &str,
platform: VcRedistributablePlatform
) -> Result<()>
pub fn add_visual_cpp_redistributable(
&mut self,
redist_version: &str,
platform: VcRedistributablePlatform
) -> Result<()>
Attempt to add the Visual C++ Redistributable DLLs to the program files manifest.
This will use vswhere.exe
to attempt to locate a Visual Studio installation
and will attempt to find the Visual C++ Redistributable DLLs (vcruntimeXXX.dll
) in
that install. Discovered DLLs are materialized in the root directory of the
program files manifest.
The latest installed version is always used.
As this requires vswhere.exe
and a Visual Studio installation, this function
will always error outside of Windows.
sourcepub fn upgrade_code(self, value: String) -> Self
pub fn upgrade_code(self, value: String) -> Self
Set the <Product UpgradeCode
attribute value.
If not called, a deterministic value will be derived from the product name.
sourcepub fn package_keywords(self, value: String) -> Self
pub fn package_keywords(self, value: String) -> Self
Set the <Package Keywords
attribute value.
sourcepub fn package_description(self, value: String) -> Self
pub fn package_description(self, value: String) -> Self
Set the <Package Description
attribute value.
sourcepub fn license_path<P: AsRef<Path>>(self, path: P) -> Self
pub fn license_path<P: AsRef<Path>>(self, path: P) -> Self
Set the path to the file containing the license for this application.
sourcepub fn product_icon_path<P: AsRef<Path>>(self, path: P) -> Self
pub fn product_icon_path<P: AsRef<Path>>(self, path: P) -> Self
Set the path to the file containing the icon for this installer.
sourcepub fn eula_rtf_path<P: AsRef<Path>>(self, path: P) -> Self
pub fn eula_rtf_path<P: AsRef<Path>>(self, path: P) -> Self
Set the path to an rtf file containing the end user license agreement.
Set the path to a bmp file containing a banner to use for install.
The dimensions of the banner should be 493 x 58.
sourcepub fn dialog_bmp_path<P: AsRef<Path>>(self, path: P) -> Self
pub fn dialog_bmp_path<P: AsRef<Path>>(self, path: P) -> Self
Set the path to a bmp file containing an image for the install dialog.
The dimensions of the image should be 493 x 312.
sourcepub fn auto_sign_signtool(self, settings: SigntoolSign) -> Self
pub fn auto_sign_signtool(self, settings: SigntoolSign) -> Self
Register signtool signing settings to be used to automatically sign binaries.
This will automatically sign all installed binaries as well as the generated installer.
sourcepub fn add_to_installer_builder(
&self,
builder: &mut WiXInstallerBuilder
) -> Result<()>
pub fn add_to_installer_builder(
&self,
builder: &mut WiXInstallerBuilder
) -> Result<()>
Add this instance to a WiXInstallerBuilder
.
sourcepub fn default_msi_filename(&self) -> String
pub fn default_msi_filename(&self) -> String
Obtain the default filename to use for the generated MSI.
sourcepub fn to_installer_builder<P: AsRef<Path>>(
&self,
arch: &str,
build_path: P
) -> Result<WiXInstallerBuilder>
pub fn to_installer_builder<P: AsRef<Path>>(
&self,
arch: &str,
build_path: P
) -> Result<WiXInstallerBuilder>
Convert to a WiXInstallerBuilder
.
This will construct a new WiXInstallerBuilder
suitable for building
this msi installer.
Trait Implementations§
source§impl Clone for WiXSimpleMsiBuilder
impl Clone for WiXSimpleMsiBuilder
source§fn clone(&self) -> WiXSimpleMsiBuilder
fn clone(&self) -> WiXSimpleMsiBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more