Tauri

https://docs.rs/crate/tauri/latest
Admin
Tauri is a framework for building tiny, secure desktop applications for all platforms using web...
Tokens:10,624
Snippets:41
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example configurations

Source: https://docs.rs/crate/tauri/latest/source/Cargo.toml.orig

Definitions for project examples and their paths.

```toml
[[example]]
name = "commands"
path = "../../examples/commands/main.rs"

[[example]]
name = "helloworld"
path = "../../examples/helloworld/main.rs"

[[example]]
name = "drag"
path = "../../examples/drag/main.rs"

[[example]]
name = "multiwebview"
path = "../../examples/multiwebview/main.rs"
required-features = ["unstable"]

[[example]]
name = "multiwindow"
path = "../../examples/multiwindow/main.rs"

[[example]]
name = "run-return"
path = "../../examples/run-return/main.rs"

[[example]]
name = "splashscreen"
path = "../../examples/splashscreen/main.rs"

[[example]]
name = "state"
path = "../../examples/state/main.rs"

[[example]]
name = "streaming"
path = "../../examples/streaming/main.rs"

[[example]]
name = "isolation"
path = "../../examples/isolation/main.rs"
required-features = ["isolation"]
```

--------------------------------

### Build Environment and Command Configuration

Source: https://docs.rs/crate/tauri/latest/builds/3736977

Displays the rustc version, docs.rs version, and the full cargo command used to generate documentation for the Tauri crate.

```text
# rustc version
rustc 1.98.0-nightly (f46ec5218 2026-06-30)


# docs.rs version
docsrs 0.0.0 (964c90a45859fd8f9076e3cbe58470a5a4f4d4f7 2026-07-01 )


# build log
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "2b7393d687697b2006589d8d46439d7f16ad25c8d32842d5ca1e83d13184c8c6" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "wry unstable custom-protocol tray-icon devtools image-png protocol-asset test specta dynamic-acl isolation" "--no-default-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260630-1.98.0-nightly-f46ec5218\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
```

--------------------------------

### Build Command Log

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-unknown-linux-gnu.txt

The full command executed by the build system to generate documentation for the Tauri crate.

```bash
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "2b7393d687697b2006589d8d46439d7f16ad25c8d32842d5ca1e83d13184c8c6" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "wry unstable custom-protocol tray-icon devtools image-png protocol-asset test specta dynamic-acl isolation" "--no-default-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260630-1.98.0-nightly-f46ec5218\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }`
```

--------------------------------

### Build Environment Information

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-pc-windows-msvc.txt

Displays the versions of the Rust compiler and the docs.rs build system used for this specific documentation build.

```text
# rustc version
rustc 1.98.0-nightly (f46ec5218 2026-06-30)


# docs.rs version
docsrs 0.0.0 (964c90a45859fd8f9076e3cbe58470a5a4f4d4f7 2026-07-01 )
```

--------------------------------

### Generate Plugin Permissions and Documentation

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Uses tauri_utils::acl::build to autogenerate command permissions and documentation files for Tauri plugins.

```rust
    tauri_utils::acl::build::autogenerate_command_permissions(
      &commands_dir,
      &commands.iter().map(|(cmd, _)| *cmd).collect::<Vec<_>>(),
      LICENSE_HEADER,
      false,
    );
    let default_permissions: Vec<_> = commands.iter().filter(|(_cmd, default)| *default).collect();
    let all_commands_enabled_by_default = commands.len() == default_permissions.len();
    let default_permissions = default_permissions
      .into_iter()
      .map(|(cmd, _)| {
        let slugified_command = cmd.replace('_', "-");
        format!("\"allow-{slugified_command}\"")
      })
      .collect::<Vec<_>>()
      .join(", ");

    let all_enable_by_default = if all_commands_enabled_by_default {
      ", which enables all commands"
    } else {
      ""
    };

    let default_toml = format!(
      r#"{LICENSE_HEADER}# Automatically generated - DO NOT EDIT!

[default]
description = "Default permissions for the plugin{all_enable_by_default}."
permissions = [{default_permissions}]
#",
    );

    let out_path = autogenerated.join("default.toml");
    write_if_changed(out_path, default_toml)
      .unwrap_or_else(|_| panic!("unable to autogenerate default permissions"));

    let permissions = tauri_utils::acl::build::define_permissions(
      &PathBuf::from(glob::Pattern::escape(
        &permissions_out_dir.to_string_lossy(),
      ))
      .join("**")
      .join("*.toml")
      .to_string_lossy(),
      &format!("tauri:{plugin}"),
      out_dir,
      |_| true,
    )
    .unwrap_or_else(|e| panic!("failed to define permissions for {plugin}: {e}"));

    let docs_out_dir = Path::new("permissions")
      .join(plugin_directory_name)
      .join("autogenerated");
    fs::create_dir_all(&docs_out_dir).expect("failed to create plugin documentation directory");
    tauri_utils::acl::build::generate_docs(
      &permissions,
      &docs_out_dir,
      plugin.strip_prefix("tauri-plugin-").unwrap_or(plugin),
    )
    .expect("failed to generate plugin documentation page");
    all_permissions.insert(plugin.to_string(), permissions);
  }

  let default_permissions = define_default_permission_set(out_dir);
  all_permissions.insert("core".to_string(), default_permissions);

  all_permissions
}

fn define_default_permission_set(
  out_dir: &Path,
) -> Vec<tauri_utils::acl::manifest::PermissionFile> {
  let permissions_out_dir = out_dir.join("permissions");
  fs::create_dir_all(&permissions_out_dir)
    .expect("failed to create core:default permissions directory");

  let default_toml = permissions_out_dir.join("default.toml");
  let toml_content = format!(
    r#"{LICENSE_HEADER}

[default]
description = "Default core plugins set."
permissions = [{}]
#",
    PLUGINS
      .iter()
      .map(|(k, _)| format!("\"{k}:default\""))
      .collect::<Vec<_>>()
      .join(",")
  );

  write_if_changed(default_toml, toml_content)
    .unwrap_or_else(|_| panic!("unable to autogenerate core:default set"));

  tauri_utils::acl::build::define_permissions(
    &PathBuf::from(glob::Pattern::escape(
      &permissions_out_dir.to_string_lossy(),
    ))
    .join("*.toml")
    .to_string_lossy(),
    "tauri:core",
    out_dir,
    |_| true,
  )
  .unwrap_or_else(|e| panic!("failed to define permissions for `core:default` : {e}"))
}
```

--------------------------------

### Build Log Commands

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-apple-darwin.txt

Contains the shell commands executed by the build system to prepare the environment and generate documentation.

```bash
[INFO] adding target x86_64-apple-darwin for toolchain nightly
[INFO] running `Command { std: CARGO_HOME="/home/cratesfyi/workspace-builder4/cargo-home" RUSTUP_HOME="/home/cratesfyi/workspace-builder4/rustup-home" "/home/cratesfyi/workspace-builder4/cargo-home/bin/rustup" "target" "add" "--toolchain" "nightly" "x86_64-apple-darwin", kill_on_drop: false }`
[INFO] [stderr] info: component rust-std for target x86_64-apple-darwin is up to date
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "2b7393d687697b2006589d8d46439d7f16ad25c8d32842d5ca1e83d13184c8c6" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "wry unstable custom-protocol tray-icon devtools image-png protocol-asset test specta dynamic-acl isolation" "--no-default-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260630-1.98.0-nightly-f46ec5218\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-apple-darwin\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-apple-darwin", kill_on_drop: false }`
```

--------------------------------

### Platform-specific dependencies

Source: https://docs.rs/crate/tauri/latest/source/Cargo.toml.orig

Configuration blocks for macOS, Windows, mobile, Android, and UIKit targets.

```toml
[target.'cfg(target_os = "macos")'.dependencies]
embed_plist = "1.2"
plist = "1"
objc2-foundation = { version = "0.3", default-features = false, features = [
  "std",
  "NSData",
  "NSThread",
] }
objc2-app-kit = { version = "0.3", default-features = false, features = [
  "std",
  "NSApplication",
  "NSColor",
  "NSResponder",
  "NSView",
  "NSWindow",
  "NSImage",
] }
objc2-web-kit = { version = "0.3", default-features = false, features = [
  "objc2-app-kit",
  "WKWebView",
  "WKWebViewConfiguration",
  "WKUserContentController",
] }
window-vibrancy = "0.6"
```

```toml
[target."cfg(windows)".dependencies]
webview2-com = { version = "0.38", optional = true }
window-vibrancy = "0.6"
windows = { version = "0.61", features = [
  "Win32_Foundation",
  "Win32_UI",
  "Win32_UI_WindowsAndMessaging",
] }
```

```toml
[target.'cfg(any(target_os = "android", all(target_vendor = "apple", not(target_os = "macos"))))'.dependencies]
bytes = { version = "1", features = ["serde"] }
reqwest = { version = "0.13", default-features = false, features = [
  "json",
  "stream",
] }
rustls = { version = "0.23", default-features = false, features = [
  "ring",
], optional = true }
```

```toml
[target.'cfg(target_os = "android")'.dependencies]
jni = "0.21"
```

```toml
[target.'cfg(all(target_vendor = "apple", not(target_os = "macos")))'.dependencies]
libc = "0.2"
swift-rs = "1"
objc2-ui-kit = { version = "0.3.0", default-features = false, features = [
  "UIApplication",
  "UIResponder",
  "UIView",
] }
```

--------------------------------

### Build Log Output

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-linux-android.txt

Contains the execution logs for target addition and the cargo rustdoc command.

```text
[INFO] adding target x86_64-linux-android for toolchain nightly
[INFO] running `Command { std: CARGO_HOME="/home/cratesfyi/workspace-builder4/cargo-home" RUSTUP_HOME="/home/cratesfyi/workspace-builder4/rustup-home" "/home/cratesfyi/workspace-builder4/cargo-home/bin/rustup" "target" "add" "--toolchain" "nightly" "x86_64-linux-android", kill_on_drop: false }`
[INFO] [stderr] info: component rust-std for target x86_64-linux-android is up to date
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "2b7393d687697b2006589d8d46439d7f16ad25c8d32842d5ca1e83d13184c8c6" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "wry unstable custom-protocol tray-icon devtools image-png protocol-asset test specta dynamic-acl isolation" "--no-default-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260630-1.98.0-nightly-f46ec5218\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-linux-android\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-linux-android", kill_on_drop: false }`
[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr]  Documenting tauri v2.11.5 (/opt/rustwide/workdir)
[INFO] [stderr] warning: unresolved link to `ScrollBarStyle::FluentOverlay`
[INFO] [stderr]     --> src/webview/webview_window.rs:1224:13
[INFO] [stderr]      |
[INFO] [stderr] 1224 |   ///   - [`ScrollBarStyle::FluentOverlay`] requires WebView2 Runtime version 125.0.2535.41 or higher,
[INFO] [stderr]      |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the enum `ScrollBarStyle` has no variant or associated item named `FluentOverlay`
[INFO] [stderr]      |
[INFO] [stderr]      = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `WebviewBuilder::with_related_view`
[INFO] [stderr]    --> src/webview/mod.rs:246:75
[INFO] [stderr]     |
[INFO] [stderr] 246 |   /// **Linux**: The webview must be related to the caller webview. See [`WebviewBuilder::with_related_view`].
[INFO] [stderr]     |                                                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `WebviewBuilder` has no field or associated item named `with_related_view`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `WebviewBuilder::with_environment`
[INFO] [stderr]    --> src/webview/mod.rs:247:91
[INFO] [stderr]     |
[INFO] [stderr] 247 |   /// **Windows**: The webview must use the same environment as the caller webview. See [`WebviewBuilder::with_environment`].
[INFO] [stderr]     |                                                                                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `WebviewBuilder` has no field or associated item named `with_environment`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `WebviewBuilder::with_webview_configuration`
[INFO] [stderr]    --> src/webview/mod.rs:248:99
[INFO] [stderr]     |
[INFO] [stderr] 248 | ...ation as the caller webview. See [`WebviewBuilder::with_webview_configuration`] and [`NewWindowFeatures::webview_configuration`].
[INFO] [stderr]     |                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `WebviewBuilder` has no field or associated item named `with_webview_configuration`
[INFO] [stderr] 
[INFO] [stderr] warning: unresolved link to `NewWindowFeatures::webview_configuration`
[INFO] [stderr]    --> src/webview/mod.rs:248:150
[INFO] [stderr]     |
[INFO] [stderr] 248 | ...with_webview_configuration`] and [`NewWindowFeatures::webview_configuration`].
[INFO] [stderr]     |                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the struct `NewWindowFeatures` has no field or associated item named `webview_configuration`
```

--------------------------------

### Configure Build Environment and Android Codegen

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Handles platform-specific build workarounds, generates Android Kotlin files, and manages ProGuard configurations.

```rust
  // workaround needed to prevent `STATUS_ENTRYPOINT_NOT_FOUND` error in tests
  // see https://github.com/tauri-apps/tauri/pull/4383#issuecomment-1212221864
  let target_env = std::env::var("CARGO_CFG_TARGET_ENV");
  let is_tauri_workspace = std::env::var("__TAURI_WORKSPACE__").is_ok_and(|v| v == "true");
  if is_tauri_workspace && target_os == "windows" && Ok("msvc") == target_env.as_deref() {
    embed_manifest_for_tests();
  }

  if target_os == "android" {
    fn env_var(var: &str) -> String {
      std::env::var(var).unwrap_or_else(|_| {
        panic!("`{var}` is not set, which is needed to generate the kotlin files for android.")
      })
    }

    if let Ok(kotlin_out_dir) = std::env::var("WRY_ANDROID_KOTLIN_FILES_OUT_DIR") {
      let package = env_var("WRY_ANDROID_PACKAGE");
      let library = env_var("WRY_ANDROID_LIBRARY");

      let kotlin_out_dir = PathBuf::from(&kotlin_out_dir)
        .canonicalize()
        .unwrap_or_else(move |_| {
          panic!("Failed to canonicalize `WRY_ANDROID_KOTLIN_FILES_OUT_DIR` path {kotlin_out_dir}")
        });

      let kotlin_files_path =
        PathBuf::from(env_var("CARGO_MANIFEST_DIR")).join("mobile/android-codegen");
      println!("cargo:rerun-if-changed={}", kotlin_files_path.display());
      let kotlin_files =
        fs::read_dir(kotlin_files_path).expect("failed to read Android codegen directory");

      for file in kotlin_files {
        let file = file.unwrap();

        let content = fs::read_to_string(file.path())
          .expect("failed to read kotlin file as string")
          .replace("{{package}}", &package)
          .replace("{{library}}", &library);

        let out_path = kotlin_out_dir.join(file.file_name());
        // Overwrite only if changed to not trigger rebuilds
        write_if_changed(&out_path, &content).expect("Failed to write kotlin file");

        println!("cargo:rerun-if-changed={}", out_path.display());
      }
    }

    if let Some(project_dir) = env::var_os("TAURI_ANDROID_PROJECT_PATH").map(PathBuf::from) {
      let package_unescaped = env::var("TAURI_ANDROID_PACKAGE_UNESCAPED")
        .unwrap_or_else(|_| env_var("WRY_ANDROID_PACKAGE").replace('`', ""));
      let tauri_proguard =
        include_str!("./mobile/proguard-tauri.pro").replace("$PACKAGE", &package_unescaped);
      std::fs::write(
        project_dir.join("app").join("proguard-tauri.pro"),
        tauri_proguard,
      )
      .expect("failed to write proguard-tauri.pro");
    }

    let lib_path =
      PathBuf::from(std::env::var_os("CARGO_MANIFEST_DIR").unwrap()).join("mobile/android");
    println!("cargo:android_library_path={}", lib_path.display());
  }
```

--------------------------------

### Build and Development dependencies

Source: https://docs.rs/crate/tauri/latest/source/Cargo.toml.orig

Dependencies required for the build process and development environment.

```toml
[build-dependencies]
glob = "0.3"
heck = "0.5"
tauri-build = { path = "../tauri-build/", default-features = false, version = "2.6.3" }
tauri-utils = { path = "../tauri-utils/", version = "2.9.3", features = [
  "build-2",
] }
```

```toml
[dev-dependencies]
proptest = "1.6.0"
quickcheck = "1.0.3"
quickcheck_macros = "1.0.0"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
tauri = { path = ".", default-features = false, features = ["wry"] }
tokio = { version = "1", features = ["full"] }
cargo_toml = "0.22"
http-range = "0.1.5"
```

--------------------------------

### Define Global API Scripts and Permissions

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Registers global API scripts and generates allowed command permissions for the build.

```rust
  let tauri_global_scripts = PathBuf::from("./scripts/bundle.global.js")
    .canonicalize()
    .expect("failed to canonicalize tauri global API script path");
  tauri_utils::plugin::define_global_api_script_path(&tauri_global_scripts);
  // This should usually be done in `tauri-build`,
  // but we need to do this here for the examples in this workspace to work as they don't have build scripts
  if is_tauri_workspace {
    tauri_utils::plugin::save_global_api_scripts_paths(&out_dir, Some(tauri_global_scripts));
  }

  let permissions = define_permissions(&out_dir);
  tauri_utils::acl::build::generate_allowed_commands(&out_dir, None, permissions).unwrap();
}
```

--------------------------------

### Define Plugin Permissions

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Iterates through plugins to define and locate permission files.

```rust
fn define_permissions(
  out_dir: &Path,
) -> BTreeMap<String, Vec<tauri_utils::acl::manifest::PermissionFile>> {
  let mut all_permissions = BTreeMap::new();
  for (plugin, commands) in PLUGINS {
    let plugin_directory_name = plugin.strip_prefix("core:").unwrap_or(plugin);
    let permissions_out_dir = out_dir.join("permissions").join(plugin_directory_name);
    let autogenerated =
      permissions_out_dir.join(tauri_utils::acl::build::AUTOGENERATED_FOLDER_NAME);
    let commands_dir = autogenerated.join("commands");
```

--------------------------------

### Documentation Build Command

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-pc-windows-msvc.txt

The cargo command executed to generate documentation for the Tauri crate with specific feature flags and target configurations.

```text
# build log
[INFO] running `Command { std: "docker" "exec" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-w" "/opt/rustwide/workdir" "--user" "1001:1001" "2b7393d687697b2006589d8d46439d7f16ad25c8d32842d5ca1e83d13184c8c6" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--features" "wry unstable custom-protocol tray-icon devtools image-png protocol-asset test specta dynamic-acl isolation" "--no-default-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20260630-1.98.0-nightly-f46ec5218\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-pc-windows-msvc\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-pc-windows-msvc", kill_on_drop: false }`
```

--------------------------------

### Tauri Build Script Plugin Configuration

Source: https://docs.rs/crate/tauri/latest/source/build.rs

This build script defines the available plugins and their associated commands, specifying whether each command is enabled by default.

```rust
// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

use heck::AsShoutySnakeCase;
use tauri_utils::write_if_changed;

use std::{
  collections::BTreeMap,
  env, fs,
  path::{Path, PathBuf},
  sync::{Mutex, OnceLock},
};

static CHECKED_FEATURES: OnceLock<Mutex<Vec<String>>> = OnceLock::new();
const PLUGINS: &[(&str, &[(&str, bool)])] = &[
  // (plugin_name, &[(command, enabled-by_default)])
  // TODO: Enable this in v3
  // ("core:channel", &[("fetch", true)]),
  (
    "core:path",
    &[
      ("resolve_directory", true),
      ("resolve", true),
      ("normalize", true),
      ("join", true),
      ("dirname", true),
      ("extname", true),
      ("basename", true),
      ("is_absolute", true),
    ],
  ),
  (
    "core:event",
    &[
      ("listen", true),
      ("unlisten", true),
      ("emit", true),
      ("emit_to", true),
    ],
  ),
  (
    "core:window",
    &[
      ("create", false),
      // getters
      ("get_all_windows", true),
      ("scale_factor", true),
      ("inner_position", true),
      ("outer_position", true),
      ("inner_size", true),
      ("outer_size", true),
      ("is_fullscreen", true),
      ("is_minimized", true),
      ("is_maximized", true),
      ("is_focused", true),
      ("is_decorated", true),
      ("is_resizable", true),
      ("is_maximizable", true),
      ("is_minimizable", true),
      ("is_closable", true),
      ("is_visible", true),
      ("is_enabled", true),
      ("title", true),
      ("current_monitor", true),
      ("primary_monitor", true),
      ("monitor_from_point", true),
      ("available_monitors", true),
      ("cursor_position", true),
      ("theme", true),
      ("is_always_on_top", true),
      ("activity_name", true),
      ("scene_identifier", true),
      // setters
      ("center", false),
      ("request_user_attention", false),
      ("set_enabled", false),
      ("set_resizable", false),
      ("set_maximizable", false),
      ("set_minimizable", false),
      ("set_closable", false),
      ("set_title", false),
      ("maximize", false),
      ("unmaximize", false),
      ("minimize", false),
      ("unminimize", false),
      ("show", false),
      ("hide", false),
      ("close", false),
      ("destroy", false),
      ("set_decorations", false),
      ("set_shadow", false),
      ("set_effects", false),
      ("set_always_on_top", false),
      ("set_always_on_bottom", false),
      ("set_visible_on_all_workspaces", false),
      ("set_content_protected", false),
      ("set_size", false),
      ("set_min_size", false),
```

--------------------------------

### Docs.rs Version

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-linux-android.txt

Displays the version of the docs.rs builder.

```text
docsrs 0.0.0 (964c90a45859fd8f9076e3cbe58470a5a4f4d4f7 2026-07-01 )
```

--------------------------------

### Tauri Cargo.toml Configuration

Source: https://docs.rs/crate/tauri/latest/source/Cargo.toml

The normalized Cargo.toml file for the Tauri crate, including package metadata, build instructions, and documentation-specific feature flags.

```toml
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.

[package]
edition = "2021"
rust-version = "1.77.2"
name = "tauri"
version = "2.11.5"
authors = ["Tauri Programme within The Commons Conservancy"]
build = "build.rs"
links = "Tauri"
exclude = [
    "/test",
    "/.scripts",
    "CHANGELOG.md",
    "/target",
]
autolib = false
autobins = false
autoexamples = false
autotests = false
autobenches = false
description = "Make tiny, secure apps for all desktop platforms with Tauri"
homepage = "https://tauri.app/"
readme = "README.md"
categories = [
    "gui",
    "web-programming",
]
license = "Apache-2.0 OR MIT"
repository = "https://github.com/tauri-apps/tauri"

[package.metadata.docs.rs]
no-default-features = true
features = [
    "wry",
    "unstable",
    "custom-protocol",
    "tray-icon",
    "devtools",
    "image-png",
    "protocol-asset",
    "test",
    "specta",
    "dynamic-acl",
    "isolation",
]
default-target = "x86_64-unknown-linux-gnu"
targets = [
    "x86_64-pc-windows-msvc",
    "x86_64-unknown-linux-gnu",
    "x86_64-apple-darwin",
    "x86_64-linux-android",
    "x86_64-apple-ios",
]

[package.metadata.cargo-udeps.ignore]
normal = ["reqwest"]
build = ["tauri-build"]
development = ["quickcheck_macros"]
```

--------------------------------

### Define License Header

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Constant string containing the standard license header for generated files.

```rust
const LICENSE_HEADER: &str = r"# Copyright 2019-2024 Tauri Programme within The Commons Conservancy
# SPDX-License-Identifier: Apache-2.0
# SPDX-License-Identifier: MIT
";
```

--------------------------------

### Embed Windows Application Manifest

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Configures the build process to embed a specific Windows application manifest file using cargo instructions.

```rust
fn embed_manifest_for_tests() {
  static WINDOWS_MANIFEST_FILE: &str = "windows-app-manifest.xml";

  let manifest = std::env::current_dir()
    .unwrap()
    .join("../tauri-build/src")
    .join(WINDOWS_MANIFEST_FILE);

  println!("cargo:rerun-if-changed={}", manifest.display());
  // Embed the Windows application manifest file.
  println!("cargo:rustc-link-arg=/MANIFEST:EMBED");
  println!(
    "cargo:rustc-link-arg=/MANIFESTINPUT:{}",
    manifest.to_str().unwrap()
  );
  // Turn linker warnings into errors.
  println!("cargo:rustc-link-arg=/WX");
}
```

--------------------------------

### Link Apple Libraries

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Links the Tauri library for iOS builds.

```rust
  #[cfg(target_os = "macos")]
  {
    if target_os == "ios" {
      let lib_path =
        PathBuf::from(std::env::var_os("CARGO_MANIFEST_DIR").unwrap()).join("mobile/ios-api");
      tauri_utils::build::link_apple_library("Tauri", &lib_path);
      println!("cargo:ios_library_path={}", lib_path.display());
    }
  }
```

--------------------------------

### Rust Compiler Version

Source: https://docs.rs/crate/tauri/latest/builds/3736977/x86_64-linux-android.txt

Displays the version of the Rust compiler used for the build.

```text
rustc 1.98.0-nightly (f46ec5218 2026-06-30)
```

--------------------------------

### VCS Information File Content

Source: https://docs.rs/crate/tauri/latest/source/.cargo_vcs_info.json

Displays the raw JSON content of the .cargo_vcs_info.json file, containing the git commit SHA and the relative path of the crate.

```text
1
2
3
4
5
6
```

```json
{
  "git": {
    "sha1": "7cd71369c00978a3783b6ae3e9972358abbe4ae6"
  },
  "path_in_vcs": "crates/tauri"
}
```

--------------------------------

### Tauri Core Module Definitions

Source: https://docs.rs/crate/tauri/latest/source/build.rs

A collection of tuples defining core Tauri modules and their associated command permissions or internal flags.

```rust
      ("set_size_constraints", false),
      ("set_max_size", false),
      ("set_position", false),
      ("set_fullscreen", false),
      ("set_simple_fullscreen", false),
      ("set_focus", false),
      ("set_focusable", false),
      ("set_skip_taskbar", false),
      ("set_cursor_grab", false),
      ("set_cursor_visible", false),
      ("set_cursor_icon", false),
      ("set_cursor_position", false),
      ("set_ignore_cursor_events", false),
      ("start_dragging", false),
      ("start_resize_dragging", false),
      ("set_progress_bar", false),
      ("set_badge_count", false),
      ("set_overlay_icon", false),
      ("set_badge_label", false),
      ("set_icon", false),
      ("set_title_bar_style", false),
      ("set_theme", false),
      ("toggle_maximize", false),
      ("set_background_color", false),
      // internal
      ("internal_toggle_maximize", true),
    ],
  ),
  (
    "core:webview",
    &[
      ("create_webview", false),
      ("create_webview_window", false),
      // getters
      ("get_all_webviews", true),
      ("webview_position", true),
      ("webview_size", true),
      // setters
      ("webview_close", false),
      ("set_webview_size", false),
      ("set_webview_position", false),
      ("set_webview_focus", false),
      ("set_webview_auto_resize", false),
      ("set_webview_zoom", false),
      ("webview_hide", false),
      ("webview_show", false),
      ("print", false),
      ("reparent", false),
      ("clear_all_browsing_data", false),
      ("set_webview_background_color", false),
      // internal
      ("internal_toggle_devtools", true),
    ],
  ),
  (
    "core:app",
    &[
      ("version", true),
      ("name", true),
      ("tauri_version", true),
      ("identifier", true),
      ("app_show", false),
      ("app_hide", false),
      ("fetch_data_store_identifiers", false),
      ("remove_data_store", false),
      ("default_window_icon", false),
      ("set_app_theme", false),
      ("set_dock_visibility", false),
      ("bundle_type", true),
      ("register_listener", true),
      ("remove_listener", true),
      ("supports_multiple_windows", true),
    ],
  ),
  (
    "core:image",
    &[
      ("new", true),
      ("from_bytes", true),
      ("from_path", true),
      ("rgba", true),
      ("size", true),
    ],
  ),
  ("core:resources", &[("close", true)]),
  (
    "core:menu",
    &[
      ("new", true),
      ("append", true),
      ("prepend", true),
      ("insert", true),
      ("remove", true),
      ("remove_at", true),
      ("items", true),
      ("get", true),
      ("popup", true),
      ("create_default", true),
      ("set_as_app_menu", true),
      ("set_as_window_menu", true),
      ("text", true),
      ("set_text", true),
      ("is_enabled", true),
      ("set_enabled", true),
      ("set_accelerator", true),
      ("set_as_windows_menu_for_nsapp", true),
      ("set_as_help_menu_for_nsapp", true),
      ("is_checked", true),
      ("set_checked", true),
      ("set_icon", true),
    ],
  ),
  (
    "core:tray",
    &[
      ("new", true),
      ("get_by_id", true),
      ("remove_by_id", true),
      ("set_icon", true),
      ("set_menu", true),
      ("set_tooltip", true),
      ("set_title", true),
      ("set_visible", true),
      ("set_temp_dir_path", true),
      ("set_icon_as_template", true),
      ("set_icon_with_as_template", true),
      ("set_show_menu_on_left_click", true),
    ],
  ),
];
```

--------------------------------

### Cargo Feature Detection and Alias Utilities

Source: https://docs.rs/crate/tauri/latest/source/build.rs

Utility functions for checking Cargo features and setting conditional compilation aliases during the build process.

```rust
// checks if the given Cargo feature is enabled.
fn has_feature(feature: &str) -> bool {
  CHECKED_FEATURES
    .get_or_init(Default::default)
    .lock()
    .unwrap()
    .push(feature.to_string());

  // when a feature is enabled, Cargo sets the `CARGO_FEATURE_<name>` env var to 1
  // <https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts>
  std::env::var(format!("CARGO_FEATURE_{}", AsShoutySnakeCase(feature)))
    .map(|x| x == "1")
    .unwrap_or(false)
}

// creates a cfg alias if `has_feature` is true.
// `alias` must be a snake case string.
fn alias(alias: &str, has_feature: bool) {
  println!("cargo:rustc-check-cfg=cfg({alias})");
  if has_feature {
    println!("cargo:rustc-cfg={alias}");
  }
}

fn main() {
  let custom_protocol = has_feature("custom-protocol");
  let dev = !custom_protocol;
  alias("custom_protocol", custom_protocol);
  alias("dev", dev);

  println!("cargo:dev={dev}");

  let target_os = std::env::var("CARGO_CFG_TARGET_OS").unwrap();
  let mobile = target_os == "ios" || target_os == "android";
  alias("desktop", !mobile);
  alias("mobile", mobile);

  let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());

  let checked_features_out_path = out_dir.join("checked_features");
  std::fs::write(
    checked_features_out_path,
    CHECKED_FEATURES.get().unwrap().lock().unwrap().join(","),
  )
  .expect("failed to write checked_features file");
```

--------------------------------

### Feature flags

Source: https://docs.rs/crate/tauri/latest/source/Cargo.toml.orig

Conditional features that enable or disable specific Tauri functionality.

```toml
[features]
default = [
  "wry",
  "compression",
  "common-controls-v6",
  "dynamic-acl",
  "x11",
  "dbus",
]
unstable = ["tauri-runtime-wry?/unstable"]
x11 = ["tauri-runtime-wry?/x11"]
dbus = ["tauri-runtime-wry?/dbus"]
common-controls-v6 = [
  "tray-icon?/common-controls-v6",
  "muda/common-controls-v6",
  "tauri-runtime-wry?/common-controls-v6",
]
tray-icon = ["dep:tray-icon"]
tracing = ["dep:tracing", "tauri-macros/tracing", "tauri-runtime-wry?/tracing"]
test = []
compression = ["tauri-macros/compression", "tauri-utils/compression"]
wry = ["webview2-com", "webkit2gtk", "tauri-runtime-wry"]
# TODO: Remove in v3 - wry does not have this feature anymore
objc-exception = []
linux-libxdo = ["tray-icon/libxdo", "muda/libxdo"]
isolation = ["tauri-utils/isolation", "tauri-macros/isolation", "uuid"]
custom-protocol = ["tauri-macros/custom-protocol"]
# TODO: Remove these flags in v3 and/or enable them by default behind a mobile flag https://github.com/tauri-apps/tauri/issues/12384
native-tls = ["reqwest/native-tls"]
native-tls-vendored = ["reqwest/native-tls-vendored"]
rustls-tls = ["reqwest/rustls-no-provider", "dep:rustls"]
devtools = ["tauri-runtime/devtools", "tauri-runtime-wry?/devtools"]
process-relaunch-dangerous-allow-symlink-macos = [
  "tauri-utils/process-relaunch-dangerous-allow-symlink-macos",
]
macos-private-api = [
  "tauri-runtime/macos-private-api",
  "tauri-runtime-wry?/macos-private-api",
]
webview-data-url = ["data-url", "tauri-utils/html-manipulation-2"]
protocol-asset = ["http-range"]
config-json5 = ["tauri-macros/config-json5"]
config-toml = ["tauri-macros/config-toml"]
image-ico = ["image/ico"]
image-png = ["image/png"]
macos-proxy = ["tauri-runtime-wry?/macos-proxy"]
dynamic-acl = []
specta = ["dep:specta"]
```
Tokens:
Raw