FAQ - Frequently Asked Questions #1336
Replies: 41 comments 90 replies
-
|
It seems JSON is used as the default IPC (inter-process communication) format between the web and rust layer. In applications with many messages being passed, especially when the messages contain a lot of data, this could potentially be a hit on performance due to the time spent serializing the data on both sides. Would it be feasible to make the default a more efficiently-(de)serialized format such as bincode, capnproto, flatbuffers etc? |
Beta Was this translation helpful? Give feedback.
-
|
I totally agree with the "wastefulness" of JSON, as opposed to yaml for example - you really do end up wasting a lot of bandwidth. I think that there are a number of ways to solve for this, depending on which direction you are messaging and what you can afford (some of these won't be good on low-powered devices, for example). 1. Classical: From rust -> webview
2. Classical: From webview -> rust
3. Server / Client 4. FIFO 5. Homegrown 6. LUT Regarding the LUT, here is something I wrote recently in JS that may help you better understand the power of this: const accessEnum = {
RequestAlways: 1,
ReadOnly: 2,
ReadWrite: 4,
Admin: 8,
Verify: 16,
Sign: 32,
Sync: 64,
Store: 128,
Vault: 256,
Runtime: 512
}
// decompose access code
function decodeAccess (v) {
let access = 0
const accesses = []
while (v !== 0) {
if ((v & 1) !== 0) {
accesses.push(1 << access)
}
++access
v >>>= 1
}
const accessList = []
accesses.forEach(v => {
accessList.push(Object.keys(accessEnum).find(key =>
accessEnum[key] === v))
})
return accessList
}
// create accessCode
function computeAccess (arr) {
let access = 0
const keys = Object.keys(accessEnum)
arr.forEach(acc => {
if (keys.find(k => k === acc)) {
access = access + accessEnum[acc]
}
})
return access
}the point being, you can add up any of the accessEnums together, and every possible permutation can be composed in one single integer up to 1024. So by sending 21 or two bytes, I have just sent the JSON equivelent of: The JSON flavor is 63 bytes (if you use spaces) or 60 (if you use tabs) or 54 if you inline with no spaces. The point is, if you can stomach convention over configuration, this is a very fast way to get stuff done. Where this obviously falls apart is if you are sending highly dynamic data. Unless, of course, you can compose your data in a multidimensional table, but at that point things get really hard to reason about and you are probably best off using something like a TRIE... Edit: Over at Discord we had a brief discussion, and a possible solution for this that was brought up involved using rust to author a wasm blob that did the decoding/encoding of flatpak/capn/hdf5 whatever INSIDE the webview. In this way you could use the perf of wasm to deal with the message parsing... Maybe this is something to look into with WRY, but as mentioned there, wasm - while powerful - suffers from serious memory safety concerns, and is not appropriate for security conscious applications. |
Beta Was this translation helpful? Give feedback.
-
Can someone elaborate on this? I can't seem to find this method in the docs. Is this the recommended way to send binary data (image/TypedArray) from Rust to webview? Do we need to first encode the binary data into string (base64)? |
Beta Was this translation helpful? Give feedback.
-
|
@ChenKuo This comment just explores possible alternatives. It doesn't list what's (currently) implemented in tauri. So for now it's still only the invoke/event system, or if you don't need linux support custom protocols. The latter doesn't use the IPC and therefore doesn't create bottlenecks on binary data. |
Beta Was this translation helpful? Give feedback.
-
|
Raw request is out in v2 for this |
Beta Was this translation helpful? Give feedback.
-
|
How can I emit events from the backend to the webview from a separate thread? This is for an audio application that changes its state in the audio thread and needs to update the UI accordingly. fn ready(&self, webview: &mut Webview) {
let mut mut_window = webview.as_mut();
std::thread::spawn(move || {
thread::sleep_ms(3000);
emit(&mut mut_window, "rust-event", Some("Hello".to_string())).unwrap();
});
}This panics because the webview has already been dropped when emit triggers. |
Beta Was this translation helpful? Give feedback.
-
|
@nathanbabcock |
Beta Was this translation helpful? Give feedback.
-
|
Wow, that's awesome and very easy to use. Thanks for the reply 🙌 |
Beta Was this translation helpful? Give feedback.
-
|
For those of us who are completely new to Tauri, it would be great to see a full MRE of this if you have the time. Perhaps, updating a counter once a second from the back-end. I'm currently trying to work out how to pass data from the back to the front-end and I must admit that I'm struggling given that the docs (at least to me) look as though they only show the setup code, rather than how to actually invoke and receive these back-end events. Although it's entirely possible I'm missing something. |
Beta Was this translation helpful? Give feedback.
-
|
So I have no idea if this is the best way to do it, but I've come up with this MRE: App.svelte <script lang="ts">
import { listen } from "@tauri-apps/api/event";
import { onMount } from 'svelte';
let coffees = 0;
onMount(async () => {
await listen("coffee-drank", (_) => {coffees += 1});
});
</script>
<main>
<h2>Coffees: {coffees}</h2>
</main>main.rs #![cfg_attr(
all(not(debug_assertions), target_os = "windows"),
windows_subsystem = "windows"
)]
use tauri::*;
fn main() {
tauri::Builder::default()
.setup(|app| {
coffee(app.get_window("main").unwrap());
Ok(())
})
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
fn coffee(window: tauri::Window) {
std::thread::spawn(move || loop {
std::thread::sleep(std::time::Duration::from_secs(1));
window.emit("coffee-drank", {}).unwrap();
});
} |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for writing this! This saved me a good bit of time, pretty much identical in SolidJS. |
Beta Was this translation helpful? Give feedback.
-
|
Is there currently a way to keep the process running after the window is closed by a user? I would think this would be basically an Essentially the use case would be after the window is closed by the user and no longer rendered, background tasks can be ran to do some housekeeping tasks with Rust like cleanup or logging or whatever is needed before the process fully exits. |
Beta Was this translation helpful? Give feedback.
-
|
For everyone still looking for this, you can use |
Beta Was this translation helpful? Give feedback.
-
|
Seems that this has been moved to a separate file within the same example. Assuming nothing has changed, the relevant methods are called here: tauri/examples/api/src-tauri/src/lib.rs Lines 127 to 163 in cfcc7f3 |
Beta Was this translation helpful? Give feedback.
-
|
When we are making a web app and also a tauri app with the same codebase is there an easy way to tell when the app is running in desktop with tauri and when it is running on the web? thank you |
Beta Was this translation helpful? Give feedback.
-
|
I'm using Works in alpha & beta.rc |
Beta Was this translation helpful? Give feedback.
-
|
thank you that works. |
Beta Was this translation helpful? Give feedback.
-
|
you should add a interface Window {
__TAURI__: {}
}or just put this in any declare global {
interface Window {
__TAURI__: {}
}
}
|
Beta Was this translation helpful? Give feedback.
-
|
Is auto update supported in Tauri Apps? how does that work or how will it work? |
Beta Was this translation helpful? Give feedback.
-
|
yes, auto update is supported. |
Beta Was this translation helpful? Give feedback.
-
|
wow. did i already say y'all rock! |
Beta Was this translation helpful? Give feedback.
-
|
the link is dead |
Beta Was this translation helpful? Give feedback.
-
|
thanks, i updated the link above. |
Beta Was this translation helpful? Give feedback.
-
|
Hiya, |
Beta Was this translation helpful? Give feedback.
-
|
You can just include them in the |
Beta Was this translation helpful? Give feedback.
-
|
You can use |
Beta Was this translation helpful? Give feedback.
-
|
CLI App? I remember there being instructions for making our own CLI app with tauri, i cant find the docs for that. Is there a way to make a CLI app that accepts command line arguments using Tauri? |
Beta Was this translation helpful? Give feedback.
-
|
I don't think we have a guide for it but this page (here for rust) should help you. |
Beta Was this translation helpful? Give feedback.
-
|
There is a guide now. |
Beta Was this translation helpful? Give feedback.
-
|
For which browsers the javascript code should be polyfilled? I know IE11 is not used. Will the webview support esnext or es2020 code? |
Beta Was this translation helpful? Give feedback.
-
|
See this discussion for details on ES support across different platforms' webviews. It seems like ES2018 is supported across all platforms. |
Beta Was this translation helpful? Give feedback.
-
|
Got a two-fold: 1: Is Tauri GPU-accelerated? Thanks in advance. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
Perfect. Thank you so much for the response. :) |
Beta Was this translation helpful? Give feedback.
-
Hi, Is this not possible anymore? |
Beta Was this translation helpful? Give feedback.
-
|
Ah found it, I think it's no longer documented? |
Beta Was this translation helpful? Give feedback.
-
|
When setting decorations to false, I hope to have the ability to preserve borders and shadows It seems a bit difficult to make window shadows and borders in webview |
Beta Was this translation helpful? Give feedback.
-
|
For shadows, check this tauri-apps/tao#157. The border is probably not possible to separate it into its own option, it will come with the shadows but even if the border isn't there, currently Tauri windows can still be resized using the mouse. |
Beta Was this translation helpful? Give feedback.
-
|
There is no problem with borders and shadows at the same time, very good |
Beta Was this translation helpful? Give feedback.
-
Beta Was this translation helpful? Give feedback.
-
|
Edit: the question was about enabling dev tools in release mode. This got answered in discord and in another discussion, for everyone searching, the answer is over here: #3059 (comment) |
Beta Was this translation helpful? Give feedback.
-
|
Cannot use and a blank page with why It cannot find index.html? |
Beta Was this translation helpful? Give feedback.
-
|
See #3082 |
Beta Was this translation helpful? Give feedback.
-
|
I'm still new to rust/tauri so bear with me. I'd like to be able to modify the state, but I can't find a way to set the underlying state as mutable: // game definition:
pub struct GameState {
// stuff
}
impl GameState {
pub fn reset(&mut self) {
// do stuff
}
}
#[tauri::command]
fn new_game(state: tauri::State<game::GameState>) {
state.reset(); // error (cannot borrow data in a dereference of `tauri::State<'_, game::GameState>` as mutable)
}Error message:
Is there a way to do this? Or should we consider state as immutable? If state is immutable, how do we create new state? |
Beta Was this translation helpful? Give feedback.
-
|
You need to wrap your GameState struct (or relevant fields) in a Mutex for interior mutability. See https://github.com/tauri-apps/tauri/blob/next/examples/state/src-tauri/src/main.rs for an example. The Arc in there is optional, you don't need it most of the times especially since tauri::State itself uses an Arc behind the scenes. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the super quick reply! That did the trick. Here's the change I made: pub struct GameState(Mutex<Game>);
pub struct Game {
// stuff
}
impl GameState {
pub fn reset(&mut self) {
// do stuff
}
}
fn main() {
tauri::Builder::default()
.manage(GameState(Default::default()))
.invoke_handler(tauri::generate_handler![new_game])
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
#[tauri::command]
fn new_game(state: tauri::State<game::GameState>) {
state.0.lock().unwrap().reset();
} |
Beta Was this translation helpful? Give feedback.
-
|
I am also fairly new to both rust and tauri. But I have a bit of a code base by now and here is what I learned. You need to wrap the Tauri uses multiple threads therefore the The difference between those two in short is that the Here an example with use std::sync::Mutex;
pub struct InnerGameState {
pub foo: String,
}
impl InnerGameState {
pub fn reset(&mut self) {
// do stuff
}
}
pub struct GameState(pub Mutex<InnerGameState>);
#[tauri::command]
fn new_game(state: tauri::State<GameState>) {
let mut state_guard = state.0.lock().unwrap();
// Change field of state struct
state_guard.foo = String::from("bar");
// Call method on state struct
state_guard.reset();
// Replace state struct; here you need to dereference the guard to get the pointer to the inner value (I think)
*state_guard = InnerGameState { foo: String::from("bar") };
}
fn main() {
tauri::Builder::default()
.manage(GameState(Mutex::new(InnerGameState { foo: String::from("foo") })))
.invoke_handler(tauri::generate_handler![new_game])
.run(tauri::generate_context!())
.expect("error while running tauri application");
}And here an example with use std::sync::RwLock;
pub struct InnerGameState {
pub foo: String,
}
impl InnerGameState {
pub fn reset(&mut self) {
// do stuff
}
}
pub struct GameState(pub RwLock<InnerGameState>);
#[tauri::command]
fn new_game(state: tauri::State<GameState>) {
let mut state_guard = state.0.write().unwrap();
// Change field of state struct
state_guard.foo = String::from("bar");
// Call method on state struct
state_guard.reset();
// Replace state struct; here you need to dereference the guard to get the pointer to the inner value (I think)
*state_guard = InnerGameState { foo: String::from("bar") };
}
fn main() {
tauri::Builder::default()
.manage(GameState(RwLock::new(InnerGameState { foo: String::from("foo") })))
.invoke_handler(tauri::generate_handler![new_game])
.run(tauri::generate_context!())
.expect("error while running tauri application");
}I use the EDIT: Oh got already answered while writing this. |
Beta Was this translation helpful? Give feedback.
-
|
How to enable dev tool (ctrl+shift+i) in production build? |
Beta Was this translation helpful? Give feedback.
-
|
Add following configuration to [profile.release.package.wry]
debug = true
debug-assertions = true |
Beta Was this translation helpful? Give feedback.
-
|
All answers/credits to my questions here are from Discord, from the great Tauri team. |
Beta Was this translation helpful? Give feedback.
-
|
Can I use VueJs/Vuex dev tools while developing my Quasar application in Tauri? |
Beta Was this translation helpful? Give feedback.
-
|
You need to add vue-devtools to you project which use Electron to remotely connect to your Tauri session. |
Beta Was this translation helpful? Give feedback.
-
|
How do I listen for routing changes in the WebView？ |
Beta Was this translation helpful? Give feedback.
-
|
Check out https://developer.mozilla.org/en-US/docs/Web/API/Window/hashchange_event Or mutation listener on the body, have not tried this myself, and check the window.location for any changes. I'd go with one of the above though, hashchange or popstate. Then use the Tauri api if you need the rust to be aware of it. On a rethink I thought maybe history is not available in Tauri since it is not a Browser just the view. So MutationObserver is the way to go. Look for a change to |
Beta Was this translation helpful? Give feedback.
-
|
Can I create a micro service architecture with tauri? What I would like to achieve it is to have for example a repository for file system manager written in tauri (with functions written in rust that interact with os fs and web UI), which I can then embed in another tauri application in another repository, let's call it If not, I'd say that would be a good feature to have :) |
Beta Was this translation helpful? Give feedback.
-
|
Hi @KrosFire, while I am new to Tauri I am not new to the concept you've mentioned and doing likewise with Electron. I'll take a stab at this if you don't mind. This would really not be a Tauri thing. It is more source organization and dependency arrangement. A monorepo with npm workspaces would achieve some of what you want (yarn and pnpm same deal), and Cargo may do this as well. Look into workspaces, but you don't have to use a monorepo, it is just a convenient way to maintain the pipelines for running testing etc. For the |
Beta Was this translation helpful? Give feedback.
-
|
Hi! What's the best way to implement "Check for updates" button that will trigger auto-updater? |
Beta Was this translation helpful? Give feedback.
-
|
There are some functions you can use to check for and install updates: https://tauri.app/v1/api/js/updater#functions / https://tauri.app/v1/guides/distribution/updater#javascript-api. |
Beta Was this translation helpful? Give feedback.
-
|
nice, thank you! I somehow missed it in the docs. I thought if I use this package, I will have to disable default dialog option, but maybe it's not like that. I would simply like to have 'check for updates' button in the tray menu. I will use the rust alternative https://docs.rs/tauri/1.2.4/tauri/updater/struct.UpdateBuilder.html#method.check |
Beta Was this translation helpful? Give feedback.
-
|
hm, it seems that I can only manually trigger update check if I completely intercept the updater event loop. Can I just trigger the default tauri updater (the one that can show dialog) to check for update myself? |
Beta Was this translation helpful? Give feedback.
-
|
It's not documented since it's not really intended but you can invoke the imo we should improve this aspect in the future, ie supporting this officially (needs a few changes) |
Beta Was this translation helpful? Give feedback.
-
|
How can I reduce the number of auxiliary processes tauri launch? I was able to do so in Electron when trying to reduce memory footprint, would like to do the same with tauri. |
Beta Was this translation helpful? Give feedback.
-
|
Which process do you mean? It should only spawn one at least on mac |
Beta Was this translation helpful? Give feedback.
-
|
On windows, it spawns tauri main process (4MB) , a renderer (30MB) , a GPU process (20MB) and a utility process (15MB). |
Beta Was this translation helpful? Give feedback.
-
|
That's just how WebView2 works, it uses multiple processes, I don't think there's anything Tauri can do about that, although I don't know what APIs exist for WebView2 Note that if you have multiple instances of the same app, I believe some of those processes would be reused |
Beta Was this translation helpful? Give feedback.
-
|
Anyway to pass some params/switches to webview? |
Beta Was this translation helpful? Give feedback.
-
|
On Windows that's possible, yeah. Tauri 1.3 will have a |
Beta Was this translation helpful? Give feedback.
-
|
I would like to get the size of the taskbar, is it possible? |
Beta Was this translation helpful? Give feedback.
-
|
The only way i heard of is to use the windows or windows-sys crate and then call SystemParamtersInfoA with |
Beta Was this translation helpful? Give feedback.
-
|
If I request a feature from tauri, should I submit the issue to tauri or tao? |
Beta Was this translation helpful? Give feedback.
-
|
Start at Tauri and we'll let the bot create upstream issues if needed. |
Beta Was this translation helpful? Give feedback.
-
|
Thank you, I will create an Issue. |
Beta Was this translation helpful? Give feedback.
-
|
Hi! I am using tauri with sveltekit. One issue that is quite annoying is how errors are displayed:
as you can see, there is no stack trace and it's very hard to find where the error is coming from. (in this case it's a simple 'throw' inside the main page's <script> tag) is this a known issue? maybe I should configure somethings more that just enabling source maps? |
Beta Was this translation helpful? Give feedback.
-
|
That should 100% be something that's up to SvelteKit and the webview to provide better errors for. Tauri isn't involved at that level of the app. |
Beta Was this translation helpful? Give feedback.
-
|
Hi! |
Beta Was this translation helpful? Give feedback.
-
|
I'm also looking for this. I found it can be done in Electron, so maybe there's a way to replicate this in Tauri? |
Beta Was this translation helpful? Give feedback.
-
|
@DLHTX They're tracking this in this issue. Looks like it'll be possible in Tauri v2. |
Beta Was this translation helpful? Give feedback.
-
|
What will happen if my command handler panics? |
Beta Was this translation helpful? Give feedback.
-
|
If it's an async function the tokio worker thread will panic but your app will keep running, not sure if there are serious consequences of the worker thread crash or not tbh. |
Beta Was this translation helpful? Give feedback.
-
|
I think it's a good idea to wrap command handler calls in catch_unwind and if it panics return some error to javascript. |
Beta Was this translation helpful? Give feedback.
-
|
Has there been any updates on data sharing the between backend and frontend for big files like images, sound or video? |
Beta Was this translation helpful? Give feedback.
-
|
Not really. For v1 we still recommend custom protocols (though that's broken for media playback on linux...). v2 will use the same tech for the general IPC. |
Beta Was this translation helpful? Give feedback.
-
|
Tried v2 and the new IPC it's working great. This is what I have in my Cargo.toml But it fails with incompatible package versions. Also tried using the git version of the plugin but same issue. Is there any way that I can test the fix without waiting for it to be merged? |
Beta Was this translation helpful? Give feedback.
-
|
I managed to get register_uri_scheme_protocol working fine. but either blocks the main rendering thread. Is there any better approach to this? |
Beta Was this translation helpful? Give feedback.
-
|
Nope, not until we figure out how to resolve tauri-apps/wry#420 / tauri-apps/wry#872. (btw, reqwest has a blocking api too) |
Beta Was this translation helpful? Give feedback.
This comment was marked as spam.
This comment was marked as spam.
-
|
Hi! I have already seen the documents about Window, but I couldn't find a feature that is similar to Electron.I might have missed it in the documentation, and if so, I would appreciate it if you could point me in the right direction. If tauri dosen't support this, is there possibly another way to workaround and take snapshot for a window? Thank you! |
Beta Was this translation helpful? Give feedback.
-
|
There's this plugin for Windows and Linux: https://github.com/Fractal-Tess/tauri-plugin-snapshot - afaik the only alternative would be to use the native webview apis directly (which is what the plugin does internally) |
Beta Was this translation helpful? Give feedback.
-
|
Hi! Is there a I have to spawn a async task to do some network functions. A I tried I then tried What I have as a workaround is spawn the aysnc task in the tauri::Builder::default()
.plugin(tauri_plugin_window::init())
.plugin(tauri_plugin_fs::init())
.plugin(tauri_plugin_dialog::init())
.invoke_handler(tauri::generate_handler![
send_text_message,
send_updated_profile,
request_available_peers
])
.manage(sender) // manage sender so I can send messages to network_client in commands
.setup(move |app| {
let _ = build_system_tray(app.app_handle());
let handle = app.app_handle().clone();
tauri::async_runtime::spawn(async move {
thread::sleep(Duration::from_secs(5));
let mut network_client = NetworkClient::new(receiver, keypair);
network_client.listen(handle).await;
});
Ok(())
})
.run(tauri::generate_context!())
.expect("error while running tauri application");
Ok(())It works but I would not call it a solution. Are there better approaches to do this? |
Beta Was this translation helpful? Give feedback.
-
|
What are the rules for lookup of For example, I'd like a dir structure as follows. Would it work? where Tauri and warp_server share both the javascript and the core library logic. |
Beta Was this translation helpful? Give feedback.
-
|
Yes it should work. It simply searches for the tauri.conf file (which must be next to the corresponding cargo.toml) anywhere in your current cwd (including nested folders). The folder name does not matter. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks! I'm running into problem: running Is there a way to specify the dir that |
Beta Was this translation helpful? Give feedback.
-
|
I think I ~mostly figured it out. The key was to create a One possibility (based on Tauri's example starter HTML+CSS+Vite project): {
"scripts": {
"dev": "cd webapp && vite",
"build": "cd webapp && tsc && vite build",
"preview": "cd webapp && vite preview",
"tauri": "cd webapp && tauri"
},
"workspaces": [
"./webapp"
]
}Another possibility: {
"scripts": {
"dev": "vite webapp/",
"build": "cd webapp && tsc && vite build webapp/",
"preview": "vite preview webapp/",
"tauri": "cd webapp && tauri"
},
"workspaces": [
"./webapp"
]
} |
Beta Was this translation helpful? Give feedback.
-
|
you can specify a cwd for the commands like "beforeDevCommand": {
"script": "npm run dev",
"cwd": "../webapp"
} |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to "catch" a failed command (a #[tauri::command]
fn failable() -> Result<(), &str> {
Err("owo")
}When it fails, the JavaScript Currently to invoke a command (when front uses Rust) we need use wasm_bindgen::prelude::*;
#[wasm_bindgen]
extern "C" {
#[wasm_bindgen(js_namespace = ["window", "__TAURI__", "core"])] // tauri v2: core; tauri v1: tauri
pub async fn invoke(cmd: &str, args: JsValue) -> JsValue;
}... but as we can see here it returns a So... is it possible to handle command error when frontend uses Rust? |
Beta Was this translation helpful? Give feedback.
-
|
Well I guess I found the answer in the wasm-bindgen guide, simply add a use wasm_bindgen::prelude::*;
#[wasm_bindgen]
extern "C" {
#[wasm_bindgen(catch, js_namespace = ["window", "__TAURI__", "core"])] // tauri v2: core; tauri v1: tauri
pub async fn invoke(cmd: &str, args: JsValue) -> Result<JsValue, JsValue>;
} |
Beta Was this translation helpful? Give feedback.
and others
-
We want to start collecting your frequently asked questions! So ask away and we will do our best to answer them. After a while we will bring the most frequently upvoted questions back to the website and make special care that we answer the questions to the best of our ability.
So write a question, upvote other people's questions, and try to answer questions!
Beta Was this translation helpful? Give feedback.
All reactions