Crate tauri[][src]

Tauri is a framework for building tiny, blazing fast binaries for all major desktop platforms. Developers can integrate any front-end framework that compiles to HTML, JS and CSS for building their user interface. The backend of the application is a rust-sourced binary with an API that the front-end can interact with.

The user interface in Tauri apps currently leverages Cocoa/WebKit on macOS, gtk-webkit2 on Linux and MSHTML (IE10/11) or Webkit via Edge on Windows. Tauri uses (and contributes to) the MIT licensed project that you can find at webview.

Re-exports

pub use runtime::webview::Attributes;

Modules

api

Core API. The Tauri API interface.

async_runtime

Async runtime. The singleton async runtime used by Tauri and exposed to consumers. Wraps a tokio Runtime and is meant to be used by initialization code, such as plugins initialization and app setup hooks. Fox more complex use cases, consider creating your own runtime. For command handlers, it’s recommended to use a plain async fn command.

plugin

Extend Tauri functionality.

runtime

Internal runtime between Tauri and the underlying webview runtime.

settings

The Tauri-specific settings for your runtime e.g. notification permission status.

updater

Tauri Updater

Macros

generate_context

Reads the config file at compile time and generates a Context based on its content.

generate_handler
tauri_build_context

Include a Context that was generated by tauri-build inside your build script.

Structs

App

A handle to the currently running application.

Builder

Builds a Tauri application.

Context

User supplied data required inside of a Tauri application.

InvokeMessage

An invoke message.

PageLoadPayload

The payload for the OnPageLoad hook.

Window

A webview window managed by Tauri.

Enums

Error

Runtime errors that can happen inside a Tauri application.

Icon

A icon definition.

WindowUrl

The window webview URL options.

Traits

Manager

Manages a running application.

Params

Types associated with the running Tauri application.

Type Definitions

InvokeHandler

A closure that is run everytime Tauri receives a message it doesn’t explicitly handle.

OnPageLoad

A closure that is run once every time a window is created and loaded.

Result

Result<T, ::tauri::Error>

SetupHook

A closure that is run when the Tauri application is setting up.

SyncTask

A task to run on the main thread.

Attribute Macros

command