Skip to content

Use generic runtime in command examples for testability #3255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 30, 2025
Merged

Use generic runtime in command examples for testability #3255

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
759f622
Use generic runtime in command examples for testability
marclove Apr 13, 2025
391c9fa
Merge branch 'v2' of https://github.com/tauri-apps/tauri-docs into pa…
Legend-Master May 7, 2025
ea5f2b7
Add a tip in calling rust page instead
Legend-Master May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/content/docs/develop/calling-rust.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,29 @@ async fn my_custom_command(app_handle: tauri::AppHandle) {
}
```

:::tip

`AppHandle` and `WebviewWindow` both take a generic parameter `R: Runtime`,
when the `wry` feature is enabled in `tauri` (which is enabled by default),
we default the generic to the `Wry` runtime so you can use it directly,
but if you want to use a different runtime, for example the [mock runtime],
you need to write your functions like this

```rust title="src-tauri/src/lib.rs" ins="<R: Runtime>" ins="<R>"
use tauri::{AppHandle, GlobalShortcutManager, Runtime, WebviewWindow};

#[tauri::command]
async fn my_custom_command<R: Runtime>(app_handle: AppHandle<R>, webview_window: WebviewWindow<R>) {
let app_dir = app_handle.path_resolver().app_dir();
app_handle
.global_shortcut_manager()
.register("CTRL + U", move || {});
println!("WebviewWindow: {}", webview_window.label());
}
```

:::

### Accessing Managed State

Tauri can manage state using the `manage` function on `tauri::Builder`.
Expand Down Expand Up @@ -700,3 +723,4 @@ To learn how to listen to events and emit events from your Rust code, see the [R
[Rust Event System documentation]: /develop/calling-frontend/#event-system
[channels documentation]: /develop/calling-frontend/#channels
[Calling Rust from the Frontend]: /develop/calling-rust/
[mock runtime]: https://docs.rs/tauri/2.0.0/tauri/test/struct.MockRuntime.html