takecrate 1.1.1

Adds installer functionality to standalone binaries for distribution of CLI applications
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

use std::path::PathBuf;

use crate::{error::InstallerError, os::AccessScope, path::AppPathPrefix};

/// Parameters that control how the binary is installed.
#[derive(Debug, Clone, Default)]
#[non_exhaustive]
pub struct InstallConfig {
    /// Access scope.
    pub access_scope: AccessScope,
    /// Where the files will be installed.
    pub destination: AppPathPrefix,
    /// Where the files are coming from.
    pub source_dir: PathBuf,
    /// Whether to modify the search path (PATH).
    ///
    /// On Windows, this will modify the environment variable and App Paths
    /// in the registry.
    ///
    /// On Unix with user scope, this will modify the user's shell profile
    /// config. The SHELL variable and the existence of
    /// the `.bash_profile`, `.zprofile`, or `.profile` will be used to select
    /// the appropriate file. If the file already contains the path, it will
    /// not be modified.
    /// For system scope, it's not supported.
    pub modify_os_search_path: bool,
}

impl InstallConfig {
    /// Create a new config suitable for a User install.
    pub fn new_user() -> Result<Self, InstallerError> {
        Ok(Self {
            access_scope: AccessScope::User,
            destination: AppPathPrefix::User,
            source_dir: crate::os::current_exe_dir()?,
            modify_os_search_path: true,
        })
    }

    /// Create a new config suitable for a System install.
    pub fn new_system() -> Result<Self, InstallerError> {
        Ok(Self {
            access_scope: AccessScope::System,
            destination: AppPathPrefix::System,
            source_dir: crate::os::current_exe_dir()?,
            modify_os_search_path: true,
        })
    }
}