Struct Settings

pub struct Settings { /* private fields */ }

The Settings exposed by the module.

Implementations

impl Settings

pub fn set_log_level(&mut self, level: Level)

Sets the log level for spawned commands.

pub fn log_level(&self) -> Level

Returns the log level for spawned commands.

pub fn project_out_directory(&self) -> &Path

Returns the directory where the bundle should be placed.

pub fn target(&self) -> &str

Returns the target triple.

pub fn binary_arch(&self) -> Arch

Returns the architecture for the binary being bundled (e.g. “arm”, “x86” or “x86_64”).

pub fn main_binary(&self) -> Result<&BundleBinary>

Returns the file name of the binary being bundled.

pub fn main_binary_mut(&mut self) -> Result<&mut BundleBinary>

Returns the file name of the binary being bundled.

pub fn main_binary_name(&self) -> Result<&str>

Returns the file name of the binary being bundled.

pub fn binary_path(&self, binary: &BundleBinary) -> PathBuf

Returns the path to the specified binary.

pub fn binaries(&self) -> &Vec<BundleBinary>

Returns the list of binaries to bundle.

pub fn package_types(&self) -> Result<Vec<PackageType>>

If a list of package types was specified by the command-line, returns that list filtered by the current target OS available targets.

If a target triple was specified by the command-line, returns the native package type(s) for that target.

Otherwise returns the native package type(s) for the host platform.

Fails if the host/target’s native package type is not supported.

pub fn product_name(&self) -> &str

Returns the product name.

pub fn bundle_identifier(&self) -> &str

Returns the bundle’s identifier

pub fn publisher(&self) -> Option<&str>

Returns the bundle’s publisher

pub fn icon_files(&self) -> ResourcePaths<'_>

Returns an iterator over the icon files to be used for this bundle.

pub fn resource_files(&self) -> ResourcePaths<'_>

Returns an iterator over the resource files to be included in this bundle.

pub fn external_binaries(&self) -> ResourcePaths<'_>

Returns an iterator over the external binaries to be included in this bundle.

pub fn copy_binaries(&self, path: &Path) -> Result<Vec<PathBuf>>

Copies external binaries to a path.

Returns the list of destination paths.

pub fn copy_resources(&self, path: &Path) -> Result<()>

Copies resources to a path.

pub fn version_string(&self) -> &str

Returns the version string of the bundle.

pub fn copyright_string(&self) -> Option<&str>

Returns the copyright text.

pub fn author_names(&self) -> &[String]

Returns the list of authors name.

pub fn authors_comma_separated(&self) -> Option<String>

Returns the authors as a comma-separated string.

pub fn license(&self) -> Option<String>

Returns the bundle license.

pub fn license_file(&self) -> Option<PathBuf>

Returns the bundle license file.

pub fn homepage_url(&self) -> Option<&str>

Returns the package’s homepage URL, defaulting to “” if not defined.

pub fn app_category(&self) -> Option<AppCategory>

Returns the app’s category.

pub fn file_associations(&self) -> Option<&Vec<FileAssociation>>

Return file associations.

pub fn deep_link_protocols(&self) -> Option<&Vec<DeepLinkProtocol>>

Return the list of deep link protocols to be registered for this bundle.

pub fn short_description(&self) -> &str

Returns the app’s short description.

pub fn long_description(&self) -> Option<&str>

Returns the app’s long description.

pub fn local_tools_directory(&self) -> Option<&Path>

Returns the directory for local tools path.

pub fn deb(&self) -> &DebianSettings

Returns the debian settings.

pub fn appimage(&self) -> &AppImageSettings

Returns the appimage settings.

pub fn rpm(&self) -> &RpmSettings

Returns the RPM settings.

pub fn dmg(&self) -> &DmgSettings

Returns the DMG settings.

pub fn macos(&self) -> &MacOsSettings

Returns the MacOS settings.

pub fn windows(&self) -> &WindowsSettings

Returns the Windows settings.

pub fn updater(&self) -> Option<&UpdaterSettings>

Returns the Updater settings.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.