Enum wix::Template

pub enum Template {
    Apache2,
    Gpl3,
    Mit,
    Wxs,
}

The different templates that can be printed or written to a file.

Variants

Apache2

The Apache-2.0 license.

Gpl3

The GPL-3.0 license.

Mit

The MIT license.

Wxs

A WiX Source (wxs) file.

Methods

impl Template

pub fn id(&self) -> &str

Gets the ID for the template.

In the case of a license template, the ID is the SPDX ID which is also used for the license field in the package's manifest (Cargo.toml). This is also the same value used with the cargo wix print subcommand.

Examples

extern crate wix;

use wix::Template;

fn main() {
    assert_eq!(Template::Apache2.id(), "Apache-2.0");
    assert_eq!(Template::Gpl3.id(), "GPL-3.0");
    assert_eq!(Template::Mit.id(), "MIT");
    assert_eq!(Template::Wxs.id(), "WXS");
}

pub fn possible_values() -> Vec<String>

Gets the possible string representations of each variant.

The possibilities are combination of case (upper and lower) for the various templates that are available.

Examples

extern crate wix;

use wix::Template;

fn main() {
    assert_eq!(
        Template::possible_values(),
        vec![
            "Apache-2.0",
            "apache-2.0",
            "GPL-3.0",
            "gpl-3.0",
            "MIT",
            "mit",
            "WXS",
            "wxs"
        ]
    );
}

pub fn license_ids() -> Vec<String>

Gets the IDs of all supported licenses.

Examples

extern crate wix;

use wix::Template;

fn main() {
    assert_eq!(
        Template::license_ids(),
        vec![
            "Apache-2.0",
            "GPL-3.0",
            "MIT",
        ]
    );
}

pub fn to_str(&self) -> &str

Gets the embedded contents of the template as a string.

Trait Implementations

impl Copy for Template

impl PartialEq<Template> for Template

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Clone for Template

fn clone(&self) -> Template

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Template

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

Formats the value using the given formatter.

impl Debug for Template

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

Formats the value using the given formatter.

impl FromStr for Template

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.