Struct tauri_utils::config::BundleConfig

pub struct BundleConfig {

    pub active: bool,
    pub targets: BundleTarget,
    pub create_updater_artifacts: Updater,
    pub publisher: Option<String>,
    pub homepage: Option<String>,
    pub icon: Vec<String>,
    pub resources: Option<BundleResources>,
    pub copyright: Option<String>,
    pub license: Option<String>,
    pub license_file: Option<PathBuf>,
    pub category: Option<String>,
    pub file_associations: Option<Vec<FileAssociation>>,
    pub short_description: Option<String>,
    pub long_description: Option<String>,
    pub use_local_tools_dir: bool,
    pub external_bin: Option<Vec<String>>,
    pub windows: WindowsConfig,
    pub linux: LinuxConfig,
    pub macos: MacConfig,
    pub ios: IosConfig,
    pub android: AndroidConfig,
}

Configuration for tauri-bundler.

See more: https://tauri.app/v1/api/config#bundleconfig

Fields

active: bool

Whether Tauri should bundle your application or just output the executable.

targets: BundleTarget

The bundle targets, currently supports [“deb”, “rpm”, “appimage”, “nsis”, “msi”, “app”, “dmg”] or “all”.

create_updater_artifacts: Updater

Produce updaters and their signatures or not

publisher: Option<String>

The application’s publisher. Defaults to the second element in the identifier string.

Currently maps to the Manufacturer property of the Windows Installer and the Maintainer field of debian packages if the Cargo.toml does not have the authors field.

homepage: Option<String>

A url to the home page of your application. If unset, will fallback to homepage defined in Cargo.toml.

Supported bundle targets: deb, rpm, nsis and msi.

icon: Vec<String>

The app’s icons

resources: Option<BundleResources>

App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.

copyright: Option<String>

A copyright string associated with your application.

license: Option<String>

The package’s license identifier to be included in the appropriate bundles. If not set, defaults to the license from the Cargo.toml file.

license_file: Option<PathBuf>

The path to the license file to be included in the appropriate bundles.

category: Option<String>

The application kind.

Should be one of the following: Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather.

file_associations: Option<Vec<FileAssociation>>

File associations to application.

short_description: Option<String>

A short description of your application.

long_description: Option<String>

A longer, multi-line description of the application.

use_local_tools_dir: bool

Whether to use the project’s target directory, for caching build tools (e.g., Wix and NSIS) when building this application. Defaults to false.

If true, tools will be cached in target\.tauri-tools. If false, tools will be cached in the current user’s platform-specific cache directory.

An example where it can be appropriate to set this to true is when building this application as a Windows System user (e.g., AWS EC2 workloads), because the Window system’s app data directory is restricted.

external_bin: Option<Vec<String>>

A list of—either absolute or relative—paths to binaries to embed with your application.

Note that Tauri will look for system-specific binaries following the pattern “binary-name{-target-triple}{.system-extension}”.

E.g. for the external binary “my-binary”, Tauri looks for:

• “my-binary-x86_64-pc-windows-msvc.exe” for Windows
• “my-binary-x86_64-apple-darwin” for macOS
• “my-binary-x86_64-unknown-linux-gnu” for Linux

so don’t forget to provide binaries for all targeted platforms.

windows: WindowsConfig

Configuration for the Windows bundles.

linux: LinuxConfig

Configuration for the Linux bundles.

macos: MacConfig

Configuration for the macOS bundles.

ios: IosConfig

iOS configuration.

android: AndroidConfig

Android configuration.

Trait Implementations

impl Clone for BundleConfig

fn clone(&self) -> BundleConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BundleConfig

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

Formats the value using the given formatter.

impl Default for BundleConfig

fn default() -> BundleConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BundleConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BundleConfig

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BundleConfig

impl StructuralPartialEq for BundleConfig