cargo-dist 0.32.0

Shippable application packaging for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

//! Installer Generation
//!
//! In the future this might get split up into submodules.

use std::collections::BTreeMap;

use camino::Utf8PathBuf;
use cargo_dist_schema::{ArtifactId, EnvironmentVariables, Hosting, TripleName};
use homebrew::HomebrewFragments;
use macpkg::PkgInstallerInfo;
use serde::Serialize;

use crate::{
    config::{JinjaInstallPathStrategy, LibraryStyle, ZipStyle},
    platform::{PlatformSupport, RuntimeConditions},
    InstallReceipt, ReleaseIdx,
};

use self::homebrew::HomebrewInstallerInfo;
use self::msi::MsiInstallerInfo;
use self::npm::NpmInstallerInfo;

pub mod homebrew;
pub mod macpkg;
pub mod msi;
pub mod npm;
pub mod powershell;
pub mod shell;

/// A kind of an installer
#[derive(Debug, Clone)]
#[allow(clippy::large_enum_variant)]
pub enum InstallerImpl {
    /// shell installer script
    Shell(InstallerInfo),
    /// powershell installer script
    Powershell(InstallerInfo),
    /// npm installer package
    Npm(NpmInstallerInfo),
    /// Homebrew formula
    Homebrew(HomebrewImpl),
    /// Windows msi installer
    Msi(MsiInstallerInfo),
    /// Mac pkg installer
    Pkg(PkgInstallerInfo),
}

/// Information needed to make a homebrew installer
#[derive(Debug, Clone)]
pub struct HomebrewImpl {
    /// Base information
    pub info: HomebrewInstallerInfo,

    /// Various fragments (arm64 mac, x86_64 mac, arm64 linux, x86_64 linux, etc.)
    pub fragments: HomebrewFragments<ExecutableZipFragment>,
}

/// Generic info about an installer
#[derive(Debug, Clone, Serialize)]
pub struct InstallerInfo {
    /// The parent release
    #[serde(skip)]
    pub release: ReleaseIdx,
    /// The path to generate the installer at
    pub dest_path: Utf8PathBuf,
    /// App name to use (display only)
    pub app_name: String,
    /// App version to use (display only)
    pub app_version: String,
    /// URL of the directory where artifacts can be fetched from
    pub base_urls: Vec<String>,
    /// Full information about configured hosting
    pub hosting: Hosting,
    /// Artifacts this installer can fetch
    pub artifacts: Vec<ExecutableZipFragment>,
    /// Description of the installer (a good heading)
    pub desc: String,
    /// Hint for how to run the installer
    pub hint: String,
    /// Where to install binaries
    pub install_paths: Vec<JinjaInstallPathStrategy>,
    /// Custom message to display on install success
    pub install_success_msg: String,
    /// Install receipt to write, if any
    pub receipt: Option<InstallReceipt>,
    /// Aliases to install binaries under
    pub bin_aliases: BTreeMap<TripleName, BTreeMap<String, Vec<String>>>,
    /// Whether to install generated C dynamic libraries
    pub install_libraries: Vec<LibraryStyle>,
    /// Platform-specific runtime conditions
    pub runtime_conditions: RuntimeConditions,
    /// platform support matrix
    pub platform_support: Option<PlatformSupport>,
    /// Environment variables for installer customization
    pub env_vars: Option<EnvironmentVariables>,
}

/// A fake fragment of an ExecutableZip artifact for installers
#[derive(Debug, Clone, Serialize)]
pub struct ExecutableZipFragment {
    /// The id of the artifact
    pub id: ArtifactId,
    /// The target the artifact supports
    pub target_triple: TripleName,
    /// The executables the artifact contains (name, assumed at root)
    pub executables: Vec<String>,
    /// The dynamic libraries the artifact contains (name, assumed at root)
    pub cdylibs: Vec<String>,
    /// The static libraries the artifact contains (name, assumed at root)
    pub cstaticlibs: Vec<String>,
    /// The style of zip this is
    pub zip_style: ZipStyle,
    /// The updater associated with this platform
    pub updater: Option<UpdaterFragment>,
    /// Conditions the system being installed to should ideally satisfy to install this
    pub runtime_conditions: RuntimeConditions,
}

/// A fake fragment of an Updater artifact for installers
#[derive(Debug, Clone, Serialize)]
pub struct UpdaterFragment {
    /// The id of the artifact
    pub id: ArtifactId,
    /// The binary the artifact contains (name, assumed at root)
    pub binary: ArtifactId,
}