Tauri

https://docs.rs/tauri/2.5.1/tauri
Admin
Tauri is a framework for building tiny, blazing fast binaries for all major desktop platforms,...
Tokens:3,330
Snippets:35
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### tracing Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables `tracing` for window startup, plugins, `Window::eval`, events, IPC, updater and custom protocol request handlers.

```APIDOC
tracing: Enables `tracing` for:
  - Window startup
  - Plugins
  - `Window::eval`
  - Events
  - IPC
  - Updater
  - Custom protocol request handlers
```

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

### linux-libxdo Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables linking to libxdo which enables Cut, Copy, Paste and SelectAll menu items to work on Linux.

```APIDOC
linux-libxdo: Enables linking to libxdo for Cut, Copy, Paste, SelectAll menu items on Linux.
```

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

### Tauri Utility Macros

Source: https://docs.rs/tauri/2.5.1/tauri/index

Documents key macros provided by Tauri that assist with compile-time configuration and command handling. These macros facilitate tasks such as generating application context from configuration files, creating handlers for JavaScript invocations, embedding images, and including build-time generated context.

```APIDOC
generate_context: Reads the config file at compile time and generates a Context based on its content.
generate_handler: Accepts a list of command functions. Creates a handler that allows commands to be called from JS with invoke().
include_image: Convert a .png or .ico icon to an Image for things like tauri::tray::TrayIconBuilder to consume, relative paths are resolved from CARGO_MANIFEST_DIR, not current file
tauri_build_context: Include a Context that was generated by tauri-build inside your build script.
```

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

### Tauri Core Modules Overview

Source: https://docs.rs/tauri/2.5.1/tauri/index

Summarizes the main modules within the Tauri framework, outlining their specific functionalities. This includes modules for asynchronous operations, image handling, inter-process communication (IPC), menu management, path utilities, plugin extensions, process control, security scopes, testing, tray icons, webview management, and window operations.

```APIDOC
async_runtime: The singleton async runtime used by Tauri and exposed to users.
image: Image types used by this crate and also referenced by the JavaScript API layer.
ipc: Types and functions related to Inter Procedure Call(IPC).
menu: Menu types and utilities. (desktop)
path: Path APIs.
plugin: The Tauri plugin extension to expand Tauri functionality.
process: Types and functions related to child processes management.
scope: The allowlist scopes.
test: Utilities for unit testing on Tauri applications. (test)
tray: Tray icon types and utilities. (desktop and tray-icon)
webview: The Tauri webview types and functions.
window: The Tauri window types and functions.
```

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

### specta Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Add support for `specta::specta` with Tauri arguments such as `State`, `Window` and `AppHandle`.

```APIDOC
specta: Adds support for `specta::specta` with Tauri arguments:
  - `tauri::State`
  - `tauri::window::Window`
  - `tauri::AppHandle`
```

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

### common-controls-v6 Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables Common Controls v6 support on Windows, mainly for the predefined `about` menu item.

```APIDOC
common-controls-v6: Enables Common Controls v6 support on Windows.
```

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

### native-tls-vendored Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Compile and statically link to a vendored copy of OpenSSL.

```APIDOC
native-tls-vendored: Compiles and statically links to a vendored OpenSSL copy.
```

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

### test Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables the `test` module exposing unit test helpers.

```APIDOC
test: Enables the `tauri::test` module for unit test helpers.
```

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

### process-relaunch-dangerous-allow-symlink-macos Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Allows the `process::current_binary` function to allow symlinks on macOS (this is dangerous, see the Security section in the documentation website).

```APIDOC
process-relaunch-dangerous-allow-symlink-macos: Allows `tauri::process::current_binary` to follow symlinks on macOS (dangerous).
```

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

### config-toml Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Adds support to TOML format for the configuration `Tauri.toml`.

```APIDOC
config-toml: Adds TOML format support for `Tauri.toml` configuration.
```

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

### Tauri Crate Re-exports

Source: https://docs.rs/tauri/2.5.1/tauri/index

Lists essential types and modules that are re-exported directly from the Tauri crate, providing convenient access to core components like Webview, Window, Monitor, and various utility modules. Some re-exports are marked as unstable.

```APIDOC
pub use self::webview::Webview;
pub use self::webview::WebviewWindow;
pub use self::webview::WebviewWindowBuilder;
pub use self::window::Monitor;
pub use self::window::Window;
pub use self::webview::WebviewBuilder; // unstable
pub use self::window::WindowBuilder; // unstable
pub use tauri_utils as utils;
pub use http;
pub use scope::*;
```

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

### image-ico Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Adds support to parse `.ico` image, see `Image`.

```APIDOC
image-ico: Adds support to parse `.ico` images (see `Image`).
```

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

### macos-proxy Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Adds support for `WebviewBuilder::proxy_url` on macOS. Requires macOS 14+.

```APIDOC
macos-proxy: Adds support for `tauri::webview::WebviewBuilder::proxy_url` on macOS.
  Requirement: macOS 14+
```

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

### tray-icon Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables application tray icon APIs. Enabled by default if the `trayIcon` config is defined on the `tauri.conf.json` file.

```APIDOC
tray-icon: Enables application tray icon APIs.
  Default: Enabled if `trayIcon` config is defined in `tauri.conf.json`.
```

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

### devtools Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables the developer tools (Web inspector) and `window::Window::open_devtools`. Enabled by default on debug builds. On macOS it uses private APIs, so you can’t enable it if your app will be published to the App Store.

```APIDOC
devtools: Enables developer tools (Web inspector) and `window::Window::open_devtools`.
  Default: Enabled on debug builds.
  macOS: Uses private APIs; not for App Store apps.
```

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

### webview-data-url Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables usage of data URLs on the webview.

```APIDOC
webview-data-url: Enables usage of data URLs on the webview.
```

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

### config-json5 Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Adds support to JSON5 format for `tauri.conf.json`.

```APIDOC
config-json5: Adds JSON5 format support for `tauri.conf.json`.
```

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

### objc-exception Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

This feature flag is no-op since 2.3.0.

```APIDOC
objc-exception: No-op since 2.3.0.
```

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

### Tauri Structs API Reference

Source: https://docs.rs/tauri/2.5.1/tauri/index

Lists core data structures and their purposes within a Tauri application, providing insights into the building blocks of Tauri apps.

```APIDOC
Structs:
  App: The instance of the currently running application.
  AppHandle: A handle to the currently running application.
  Asset: A resolved asset.
  AssetResolver: The asset resolver is a helper to access the `tauri_utils::assets::Assets` interface.
  Builder: Builds a Tauri application.
  CloseRequestApi: Api exposed on the `CloseRequested` event.
  Config: The Tauri configuration object.
    It is read from a file where you can define your frontend assets,
    configure the bundler and define a tray icon.
  Context: User supplied data required inside of a Tauri application.
  Env: Information about environment variables.
  Event: An event that was emitted.
  ExitRequestApi: Api exposed on the `ExitRequested` event.
  LogicalPosition: A position represented in logical pixels.
  LogicalSize: A size represented in logical pixels.
  PackageInfo: `tauri::App` package information.
  PhysicalPosition: A position represented in physical pixels.
  PhysicalSize: A size represented in physical pixels.
  Rect: A rectangular region.
  ResourceTable: Map-like data structure storing Tauri’s resources (equivalent to file descriptors).
  State: A guard for a state value.
  StateManager: The Tauri state manager.
  UriSchemeContext: Uri scheme protocol context
  UriSchemeResponder: Async uri scheme protocol responder.
  Url: A parsed URL record.
  WindowSizeConstraints: Window size constraints
```

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

### Tauri API Attribute Macros

Source: https://docs.rs/tauri/2.5.1/tauri/index

Describes the `command` attribute macro, which is used to mark a function as a command handler in Tauri. This macro automatically generates the necessary glue code, simplifying the process of exposing Rust functions to the frontend.

```APIDOC
Attribute Macros:
  command: Mark a function as a command handler. It creates a wrapper function with the necessary glue code.
```

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

### protocol-asset Cargo Allowlist Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables the `asset` custom protocol.

```APIDOC
protocol-asset: Enables the `asset` custom protocol.
```

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

### compression Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables asset compression. You should only disable this if you want faster compile times in release builds - it produces larger binaries.

```APIDOC
compression: Enables asset compression.
  Note: Disabling improves compile times but produces larger binaries.
```

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

### image-png Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Adds support to parse `.png` image, see `Image`.

```APIDOC
image-png: Adds support to parse `.png` images (see `Image`).
```

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

### macos-private-api Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables features only available in **macOS**’s private APIs, currently the `transparent` window functionality and the `fullScreenEnabled` preference setting to `true`. Enabled by default if the `tauri > macosPrivateApi` config flag is set to `true` on the `tauri.conf.json` file.

```APIDOC
macos-private-api: Enables macOS private APIs for:
  - `transparent` window functionality
  - `fullScreenEnabled` preference setting to `true`
  Default: Enabled if `tauri > macosPrivateApi` is `true` in `tauri.conf.json`.
```

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

### Tauri Constants API Reference

Source: https://docs.rs/tauri/2.5.1/tauri/index

Provides global constants used for specific values like exit codes and version information, offering fixed values for common scenarios.

```APIDOC
Constants:
  RESTART_EXIT_CODE: The exit code on `RunEvent::ExitRequested` when `AppHandle` is called.
  VERSION: The Tauri version.
```

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

### wry Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables the wry runtime. Only disable it if you want a custom runtime.

```APIDOC
wry: Enables the wry runtime.
```

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

### native-tls Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Provides TLS support to connect over HTTPS.

```APIDOC
native-tls: Provides TLS support for HTTPS connections.
```

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

### Tauri Enums API Reference

Source: https://docs.rs/tauri/2.5.1/tauri/index

Defines enumerations used for various states, events, and configurations in Tauri, providing discrete sets of values for specific contexts.

```APIDOC
Enums:
  CursorIcon: Describes the appearance of the mouse cursor.
  DeviceEventFilter:
  DragDropEvent: The drag drop event payload.
  Error: Runtime errors that can happen inside a Tauri application.
  EventLoopMessage: The user event type.
  EventTarget: Event Target
  Pattern: An application pattern.
  Position: A position that’s either physical or logical.
  RunEvent: An application event, triggered from the event loop.
  Size: A size that’s either physical or logical.
  Theme: System theme.
  UserAttentionType: Type of user attention requested on a window.
  WebviewEvent: An event from a window.
  WebviewUrl: An URL to open on a Tauri webview window.
  WindowEvent: An event from a window.
```

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

### rustls-tls Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Provides TLS support to connect over HTTPS using rustls.

```APIDOC
rustls-tls: Provides TLS support for HTTPS connections using rustls.
```

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

### Tauri API Functions

Source: https://docs.rs/tauri/2.5.1/tauri/index

Provides utility functions for checking the application's development mode status and retrieving webview version information. These functions are useful for conditional logic and debugging within Tauri applications.

```APIDOC
Functions:
  is_dev(): Whether we are running in development mode or not.
  webview_version(wry): Get WebView/Webkit version on current platform.
```

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

### custom-protocol Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Feature managed by the Tauri CLI. When enabled, Tauri assumes a production environment instead of a development one.

```APIDOC
custom-protocol: Managed by Tauri CLI. Assumes production environment when enabled.
```

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

### unstable Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables unstable features. Be careful, it might introduce breaking changes in future minor releases.

```APIDOC
unstable: Enables unstable features.
```

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

### isolation Cargo Feature

Source: https://docs.rs/tauri/2.5.1/tauri/index

Enables the isolation pattern. Enabled by default if the `app > security > pattern > use` config option is set to `isolation` on the `tauri.conf.json` file.

```APIDOC
isolation: Enables the isolation pattern.
  Default: Enabled if `app > security > pattern > use` is `isolation` in `tauri.conf.json`.
```

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

### Tauri API Type Aliases

Source: https://docs.rs/tauri/2.5.1/tauri/index

Defines common type aliases used throughout the Tauri framework for event IDs, resource IDs, results, and main thread tasks. These aliases simplify type declarations and improve code readability by providing more descriptive names for complex types.

```APIDOC
Type Aliases:
  EventId: Unique id of an event.
  ResourceId: A `ResourceId` is an integer value referencing a resource. It could be considered to be the tauri equivalent of a `file descriptor` in POSIX like operating systems.
  Result: `Result<T, ::tauri::Error>`
  SyncTask: A task to run on the main thread.
  Wry(wry): A Tauri `Runtime` wrapper around wry.
  WryHandle(wry): A Tauri `RuntimeHandle` wrapper around wry.
```

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

### Tauri API Traits

Source: https://docs.rs/tauri/2.5.1/tauri/index

Defines the core traits available in the Tauri framework, representing various functionalities like asset management, event handling, and runtime management. These traits provide interfaces for extending and interacting with the Tauri application lifecycle.

```APIDOC
Traits:
  Assets: Represents a container of file assets that are retrievable during runtime.
  Emitter: Emit events.
  Listener: Listen to events.
  Manager: Manages a running application.
  Pixel:
  Resource: Resources are Rust objects that are stored in ResourceTable and managed by tauri.
  Runtime: The webview runtime interface. A wrapper around `runtime::Runtime` with the proper user event type associated.
  RuntimeHandle: The webview runtime handle. A wrapper arond `runtime::RuntimeHandle` with the proper user event type associated.
```
Tokens:
Raw