Struct tauri::App

pub struct App<R: Runtime = Wry> { /* private fields */ }

The instance of the currently running application.

This type implements Manager which allows for manipulation of global application items.

Implementations

impl<R: Runtime> App<R>

pub fn create_window<F>(
    &self,
    label: impl Into<String>,
    url: WindowUrl,
    setup: F
) -> Result<Window<R>> where
    F: FnOnce(<R::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes) -> (<R::Dispatcher as Dispatch>::WindowBuilder, WebviewAttributes), 

Creates a new webview window.

Data URLs are only supported with the window-data-url feature flag.

pub fn tray_handle(&self) -> SystemTrayHandle<R>

This is supported on crate feature system-tray only.

Gets a handle handle to the system tray.

pub fn path_resolver(&self) -> PathResolver

The path resolver for the application.

pub fn global_shortcut_manager(&self) -> R::GlobalShortcutManager

Gets a copy of the global shortcut manager instance.

pub fn clipboard_manager(&self) -> R::ClipboardManager

Gets a copy of the clipboard manager instance.

pub fn config(&self) -> Arc<Config>

Gets the app’s configuration, defined on the tauri.conf.json file.

pub fn package_info(&self) -> &PackageInfo

Gets the app’s package information.

pub fn asset_resolver(&self) -> AssetResolver<R>

The application’s asset resolver.

impl<R: Runtime> App<R>

pub fn handle(&self) -> AppHandle<R>

Gets a handle to the application instance.

pub fn run<F: FnMut(&AppHandle<R>, RunEvent) + 'static>(self, callback: F)

Runs the application.

Example

let app = tauri::Builder::default()
  // on an actual app, remove the string argument
  .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
  .expect("error while building tauri application");
app.run(|_app_handle, event| match event {
  tauri::RunEvent::ExitRequested { api, .. } => {
    api.prevent_exit();
  }
  _ => {}
});

pub fn run_iteration(&mut self) -> RunIteration

Runs a iteration of the runtime event loop and immediately return.

Note that when using this API, app cleanup is not automatically done. The cleanup calls crate::api::process::kill_children so you may want to call that function before exiting the application. Additionally, the cleanup calls AppHandle#remove_system_tray (Windows only).

Example

let mut app = tauri::Builder::default()
  // on an actual app, remove the string argument
  .build(tauri::generate_context!("test/fixture/src-tauri/tauri.conf.json"))
  .expect("error while building tauri application");
loop {
  let iteration = app.run_iteration();
  if iteration.window_count == 0 {
    break;
  }
}

Trait Implementations

impl<R: Debug + Runtime> Debug for App<R> where
    R::GlobalShortcutManager: Debug,
    R::ClipboardManager: Debug, 

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

Formats the value using the given formatter.

impl<R: Runtime> Manager<R> for App<R>

fn config(&self) -> Arc<Config>

The Config the manager was created with.

fn emit_all<S: Serialize + Clone>(&self, event: &str, payload: S) -> Result<()>

Emits a event to all windows.

fn emit_to<S: Serialize + Clone>(
    &self,
    label: &str,
    event: &str,
    payload: S
) -> Result<()>

Emits an event to a window with the specified label.

fn listen_global<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: Fn(Event) + Send + 'static, 

Listen to a global event.

fn once_global<F>(&self, event: impl Into<String>, handler: F) -> EventHandler where
    F: FnOnce(Event) + Send + 'static, 

Listen to a global event only once.

fn trigger_global(&self, event: &str, data: Option<String>)

Trigger a global event.

fn unlisten(&self, handler_id: EventHandler)

Remove an event listener.

fn get_window(&self, label: &str) -> Option<Window<R>>

Fetch a single window from the manager.

fn windows(&self) -> HashMap<String, Window<R>>

Fetch all managed windows.

fn manage<T>(&self, state: T) where
    T: Send + Sync + 'static, 

Add state to the state managed by the application. See crate::Builder for instructions.

fn state<T>(&self) -> State<'_, T> where
    T: Send + Sync + 'static, 

Gets the managed state for the type T. Panics if the type is not managed.

fn try_state<T>(&self) -> Option<State<'_, T>> where
    T: Send + Sync + 'static, 

Tries to get the managed state for the type T. Returns None if the type is not managed.

fn env(&self) -> Env

Gets the managed Env.

fn fs_scope(&self) -> FsScope

Gets the scope for the filesystem APIs.

fn asset_protocol_scope(&self) -> FsScope

Gets the scope for the asset protocol.

fn shell_scope(&self) -> ShellScope

Gets the scope for the shell execute APIs.