Struct cargo_wix::Wix
[−]
[src]
pub struct Wix<'a> { /* fields omitted */ }
A builder for running the subcommand.
Methods
impl<'a> Wix<'a>
[src]
fn new() -> Self
[src]
Creates a new Wix
instance.
fn bin_path(self, b: Option<&'a str>) -> Self
[src]
Sets the path to the WiX Toolset's bin
folder.
The WiX Toolset's bin
folder should contain the needed candle.exe
and light.exe
applications. The default is to use the PATH system environment variable. This will
override any value obtained from the environment.
fn binary_name(self, b: Option<&'a str>) -> Self
[src]
Sets the binary name.
This overrides the binary name determined from the package's manifest (Cargo.toml).
fn capture_output(self, c: bool) -> Self
[src]
Enables or disables capturing of the output from the builder (cargo
), compiler
(candle
), linker (light
), and signer (signtool
).
The default is to capture all output, i.e. display nothing in the console but the log statements.
fn copyright_holder(self, h: Option<&'a str>) -> Self
[src]
Sets the copyright holder in the license dialog of the Windows installer (msi).
fn copyright_year(self, y: Option<&'a str>) -> Self
[src]
Sets the copyright year in the license dialog of the Windows installer (msi).
fn description(self, d: Option<&'a str>) -> Self
[src]
Sets the description.
This override the description determined from the description
field in the package's
manifest (Cargo.toml).
fn input(self, i: Option<&'a str>) -> Self
[src]
Sets the path to a file to be used as the WiX Source (wxs) file instead of wix\main.rs
.
fn license_file(self, l: Option<&'a str>) -> Self
[src]
Sets the path to a file to used as the License.txt
file within the installer.
The License.txt
file is installed into the installation location along side the bin
folder. Note, the file can be in any format with any name, but it is automatically renamed
to License.txt
during creation of the installer.
fn manufacturer(self, m: Option<&'a str>) -> Self
[src]
Overrides the first author in the authors
field of the package's manifest (Cargo.toml) as
the manufacturer within the installer.
fn no_build(self, n: bool) -> Self
[src]
Skips the building of the project with the release profile.
If true
, the project will not be built using the release profile, i.e. the cargo build --release
command will not be executed. The default is to build the project before each
creation. This is useful if building the project is more involved or is handled in
a separate process.
fn output(self, o: Option<&'a str>) -> Self
[src]
Sets the output file.
The default is to create a MSI file with the <product-name>-<version>-<arch>.msi
file
name and extension in the target\wix
folder. Use this method to override the destination
and file name of the Windows installer.
fn print_template(self, template: Template) -> Result<()>
[src]
Prints a template to stdout.
In the case of a license template, the copyright year and holder are filled by the current year and the manufacturer. The output for a license template is also in the Rich Text Format (RTF). In the case of a WiX Source (WXS) template, the output is in XML. The UpgradeCode's and Path Component's GUIDs are generated each time the WXS template is printed.
fn product_name(self, p: Option<&'a str>) -> Self
[src]
Sets the product name.
This override the product name determined from the name
field in the package's
manifest (Cargo.toml).
fn sign(self, s: bool) -> Self
[src]
Enables or disables signing of the installer after creation with the signtool
application.
fn sign_path(self, s: Option<&'a str>) -> Self
[src]
Sets the path to the folder containing the signtool.exe
file.
Normally the signtool.exe
is installed in the bin
folder of the Windows SDK
installation. THe default is to use the PATH system environment variable. This will
override any value obtained from the environment.
fn timestamp(self, t: Option<&'a str>) -> Self
[src]
Sets the URL for the timestamp server used when signing an installer.
The default is to not use a timestamp server, even though it is highly recommended. Use this method to enable signing with the timestamp.
fn init(self, force: bool) -> Result<()>
[src]
Creates the necessary sub-folders and files to immediately use the cargo wix
subcommand to
create an installer for the package.
fn create(self) -> Result<()>
[src]
Builds the project using the release profile, creates the installer (msi), and optionally signs the output.
Trait Implementations
impl<'a> Debug for Wix<'a>
[src]
impl<'a> Clone for Wix<'a>
[src]
fn clone(&self) -> Wix<'a>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more