Struct InstallerManifest 

pub struct InstallerManifest {

    pub package_identifier: PackageIdentifier,
    pub package_version: PackageVersion,
    pub channel: Option<Channel>,
    pub locale: Option<LanguageTag>,
    pub platform: Platform,
    pub minimum_os_version: Option<MinimumOSVersion>,
    pub type: Option<InstallerType>,
    pub nested_installer_type: Option<NestedInstallerType>,
    pub nested_installer_files: BTreeSet<NestedInstallerFiles>,
    pub scope: Option<Scope>,
    pub install_modes: InstallModes,
    pub switches: InstallerSwitches,
    pub success_codes: BTreeSet<InstallerSuccessCode>,
    pub expected_return_codes: BTreeSet<ExpectedReturnCodes>,
    pub upgrade_behavior: Option<UpgradeBehavior>,
    pub commands: BTreeSet<Command>,
    pub protocols: BTreeSet<Protocol>,
    pub file_extensions: BTreeSet<FileExtension>,
    pub dependencies: Dependencies,
    pub package_family_name: Option<PackageFamilyName<'static>>,
    pub product_code: Option<String>,
    pub capabilities: BTreeSet<Capability>,
    pub restricted_capabilities: BTreeSet<RestrictedCapability>,
    pub markets: Option<Markets>,
    pub aborts_terminal: bool,
    pub release_date: Option<CompactString>,
    pub install_location_required: bool,
    pub require_explicit_upgrade: bool,
    pub display_install_warnings: bool,
    pub unsupported_os_architectures: UnsupportedOSArchitecture,
    pub unsupported_arguments: UnsupportedArguments,
    pub apps_and_features_entries: AppsAndFeaturesEntries,
    pub elevation_requirement: Option<ElevationRequirement>,
    pub installation_metadata: InstallationMetadata,
    pub download_command_prohibited: bool,
    pub repair_behavior: Option<RepairBehavior>,
    pub archive_binaries_depend_on_path: bool,
    pub authentication: Option<Authentication>,
    pub installers: Vec<Installer>,
    pub manifest_type: ManifestType,
    pub manifest_version: ManifestVersion,
}

Fields

package_identifier: PackageIdentifier

The unique identifier for a given package.

This value is generally in the form of Publisher.Package. It is case-sensitive, and this value must match the folder structure under the partition directory in GitHub.

package_version: PackageVersion

The version of the package.

It is related to the specific release this manifests targets. In some cases you will see a perfectly formed semantic version number, and in other cases you might see something different. These may be date driven, or they might have other characters with some package specific meaning for example.

The Windows Package Manager client uses this version to determine if an upgrade for a package is available. In some cases, packages may be released with a marketing driven version, and that causes trouble with the winget upgrade command.

The current best practice is to use the value reported in Add / Remove Programs when this version of the package is installed. In some cases, packages do not report a version resulting in an upgrade loop or other unwanted behavior.

channel: Option<Channel>

The distribution channel for a package.

Examples may include “stable” or “beta”.

locale: Option<LanguageTag>

The locale for an installer not the package meta-data.

Some installers are compiled with locale or language specific properties. If this key is present, it is used to represent the package locale for an installer.

platform: Platform

The Windows platform targeted by the installer.

The Windows Package Manager currently supports “Windows.Desktop” and “Windows.Universal”.

minimum_os_version: Option<MinimumOSVersion>

The minimum version of the Windows operating system supported by the package.

type: Option<InstallerType>

The installer type for the package.

The Windows Package Manager supports MSIX, MSI, and executable installers. Some well known formats (Inno, Nullsoft, WiX, and Burn) provide standard sets of installer switches to provide different installer experiences. Portable packages are supported as of Windows Package Manager 1.3. Zip packages are supported as of Windows Package Manager 1.5.

nested_installer_type: Option<NestedInstallerType>

The installer type of the file within the archive which will be used as the installer.

nested_installer_files: BTreeSet<NestedInstallerFiles>

A list of all the installers to be executed within an archive.

scope: Option<Scope>

The scope the package is installed under.

The two configurations are user and machine. Some installers support only one of these scopes while others support both via arguments passed to the installer using InstallerSwitches.

install_modes: InstallModes

The install modes supported by the installer.

The Microsoft community package repository requires a package support “silent” and “silent with progress”. The Windows Package Manager also supports “interactive” installers.

switches: InstallerSwitches

The set of switches passed to installers.

success_codes: BTreeSet<InstallerSuccessCode>

Any status codes returned by the installer representing a success condition other than zero.

expected_return_codes: BTreeSet<ExpectedReturnCodes>

Any status codes returned by the installer representing a condition other than zero.

upgrade_behavior: Option<UpgradeBehavior>

What the Windows Package Manager should do regarding the currently installed package during a package upgrade.

If the package should be uninstalled first, the uninstallPrevious value should be specified. If the package should not be upgraded through WinGet, the deny value should be specified.

commands: BTreeSet<Command>

Any commands or aliases used to execute the package after it has been installed.

protocols: BTreeSet<Protocol>

Any protocols (i.e. URI schemes) supported by the package. For example: ["ftp", "ldap"]. Entries shouldn’t have trailing colons. The Windows Package Manager does not support any behavior related to protocols handled by a package.

file_extensions: BTreeSet<FileExtension>

Any file extensions supported by the package.

For example: ["html", "jpg"]. Entries shouldn’t have leading dots. The Windows Package Manager does not support any behavior related to the file extensions supported by the package.

dependencies: Dependencies

Any dependencies required to install or run the package.

package_family_name: Option<PackageFamilyName<'static>>

The package family name specified in an MSIX installer.

This value is used to assist with matching packages from a source to the program installed in Windows via Add / Remove Programs for list, and upgrade behavior.

product_code: Option<String>

The product code.

This value is used to assist with matching packages from a source to the program installed in Windows via Add / Remove Programs for list, and upgrade behavior.

capabilities: BTreeSet<Capability>

The capabilities provided by an MSIX package.

More information is available for App capability declarations.

restricted_capabilities: BTreeSet<RestrictedCapability>

The restricted capabilities provided by an MSIX package.

More information is available for App capability declarations.

markets: Option<Markets>

Any markets a package may or may not be installed in.

aborts_terminal: bool

The behavior associated with installers that abort the terminal.

This most often occurs when a user is performing an upgrade of the running terminal.

release_date: Option<CompactString>

The release date for a package, in RFC 3339 / ISO 8601 format, i.e. “YYYY-MM-DD”.

install_location_required: bool

The requirement to have an install location specified.

These installers are known to deploy files to the location the installer is executed in.

require_explicit_upgrade: bool

Identifies packages that upgrade themselves.

By default, they are excluded from winget upgrade --all.

display_install_warnings: bool

Whether a warning message is displayed to the user prior to install or upgrade if the package is known to interfere with any running applications.

unsupported_os_architectures: UnsupportedOSArchitecture

Any architectures a package is known not to be compatible with.

Generally, this is associated with emulation modes.

unsupported_arguments: UnsupportedArguments

The list of Windows Package Manager Client arguments the installer does not support.

Only the --log and --location arguments can be specified as unsupported arguments for an installer.

apps_and_features_entries: AppsAndFeaturesEntries

The values reported by Windows Apps & Features.

When a package is installed, entries are made into the Windows Registry.

elevation_requirement: Option<ElevationRequirement>

The scope in which scope a package is required to be executed under.

Some packages require user level execution while others require administrative level execution.

installation_metadata: InstallationMetadata

Allows for additional metadata to be used for deeper installation detection.

download_command_prohibited: bool

When true, this flag will prohibit the manifest from being downloaded for offline installation with the winget download command.

repair_behavior: Option<RepairBehavior>

This field controls what method is used to repair existing installations of packages.

Specifying modify will use the ModifyPath string from the package’s ARP data, uninstaller will use the Uninstall string from the package’s ARP data, and installer will download and run the installer. In each case, the Repair value from InstallerSwitches will be added as an argument when invoking the command to repair the package.

archive_binaries_depend_on_path: bool

This field controls the behavior of environment variables when installing portable packages from an archive (i.e. zip).

Specifying true will add the install location directly to the PATH environment variable. Specifying false will use the default behavior of adding a symlink to the links folder, if supported, or adding the install location directly to PATH if symlinks are not supported.

authentication: Option<Authentication>

installers: Vec<Installer>

manifest_type: ManifestType

The manifest type.

Must have the value installer. The Microsoft community package repository validation pipelines also use this value to determine appropriate validation rules when evaluating this file.

manifest_version: ManifestVersion

The manifest syntax version.

Must have the value 1.10.0. The Microsoft community package repository validation pipelines also use this value to determine appropriate validation rules when evaluating this file.

Implementations

impl InstallerManifest

pub fn optimize(&mut self)

Trait Implementations

impl Clone for InstallerManifest

fn clone(&self) -> InstallerManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstallerManifest

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

Formats the value using the given formatter.

impl Default for InstallerManifest

fn default() -> InstallerManifest

Returns the “default value” for a type.

impl Hash for InstallerManifest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Manifest for InstallerManifest

const SCHEMA: &'static str = "https://aka.ms/winget-manifest.installer.1.10.0.schema.json"

const TYPE: ManifestType = ManifestType::Installer

impl Ord for InstallerManifest

fn cmp(&self, other: &InstallerManifest) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for InstallerManifest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for InstallerManifest

fn partial_cmp(&self, other: &InstallerManifest) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for InstallerManifest

impl StructuralPartialEq for InstallerManifest