Enum PackageFormat

#[non_exhaustive]
pub enum PackageFormat {
    All,
    Default,
    App,
    Dmg,
    Wix,
    Nsis,
    Deb,
    AppImage,
    Pacman,
}

Types of supported packages by cargo-packager.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

All

All available package formats for the current platform.

See PackageFormat::platform_all

Default

The default list of package formats for the current platform.

See PackageFormat::platform_default

App

The macOS application bundle (.app).

Dmg

The macOS DMG package (.dmg).

Wix

The Microsoft Software Installer (.msi) through WiX Toolset.

Nsis

The NSIS installer (.exe).

Deb

The Linux Debian package (.deb).

AppImage

The Linux AppImage package (.AppImage).

Pacman

The Linux Pacman package (.tar.gz and PKGBUILD)

Implementations

impl PackageFormat

pub fn from_short_name(name: &str) -> Option<PackageFormat>

Maps a short name to a PackageFormat. Possible values are “deb”, “pacman”, “appimage”, “dmg”, “app”, “wix”, “nsis”.

pub fn short_name(&self) -> &'static str

Gets the short name of this PackageFormat.

pub fn platform_all() -> &'static [PackageFormat]

Gets the list of the possible package types on the current OS.

• macOS: App, Dmg
• Windows: Nsis, Wix
• Linux: Deb, AppImage, Pacman

pub fn platform_default() -> &'static [PackageFormat]

Returns the default list of targets this platform

• macOS: App, Dmg
• Windows: Nsis
• Linux: Deb, AppImage, Pacman

pub fn priority(&self) -> u32

Gets a number representing priority which used to sort package types in an order that guarantees that if a certain package type depends on another (like Dmg depending on MacOsBundle), the dependency will be built first

The lower the number, the higher the priority

Trait Implementations

impl Clone for PackageFormat

fn clone(&self) -> PackageFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageFormat

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PackageFormat

fn deserialize<__D>( __deserializer: __D, ) -> Result<PackageFormat, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PackageFormat

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

Formats the value using the given formatter.

impl PartialEq for PackageFormat

fn eq(&self, other: &PackageFormat) -> 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 Serialize for PackageFormat

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueEnum for PackageFormat

fn value_variants<'a>() -> &'a [PackageFormat]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for PackageFormat

impl Eq for PackageFormat

impl StructuralPartialEq for PackageFormat