The event module is private despite being exposed in the public API

[anna-is-cute]

Describe the bug

The event module is private, making it impossible to reference Event or EventHandler.

To Reproduce

1. Try to import tauri::event::{Event, EventHandler}

Expected behavior

The module is not private.

Platform and Versions (required):

Operating System - Windows, version 10.0.19042 X64
Webview2 - 94.0.992.38

Node.js environment
  Node.js - 16.11.0
  @tauri-apps/cli - 1.0.0-beta.10
  @tauri-apps/api - 1.0.0-beta.8

Global packages
  npm - 8.0.0
  yarn - 1.22.15

Rust environment
  rustc - 1.57.0-nightly
  cargo - 1.57.0-nightly

App directory structure
/.git
/.idea
/node_modules
/public
/src
/src-tauri

App
  tauri.rs - 1.0.0-beta.8
  build-type - bundle
  CSP - default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'
  distDir - Set automatically by Vue CLI plugin
  devPath - Set automatically by Vue CLI plugin
  framework - Vue.js (Vue CLI)
  bundler - Webpack

Additional context

I would like to do this:

fn some_func(&self) {
    self.handle.listen_global("send-packet", listener);
}

fn listener(event: Event) {
    // ...
}

Unfortunately, there is no way for me to use the necessary type, so this is impossible.

In addition, it is impossible to store the result of listen_global to be unlistened later, since there's no way to reference EventHandler in a struct.

I wonder if it's a Rust bug that the API is even allowed to do this. It's essentially exposing a private type in the public API, which you can't do normally.

[amrbashir]

try importing Event enum directly

use tauri::Event;

[anna-is-cute]

try importing Event enum directly

That's a different type. The type used for the listener is imported in lib.rs as EmittedEvent.

[amrbashir]

I see, thanks for reporting it, we probably need to combine these two event types.

[Chaostheorie]

It would be nice if the struct could either be combined (maybe adding the tauri::event::Event as an enum variant to tauri::Event?) or if tauri::event::Event could be renamed in the meantime. Otherwise, it's not possible to create external functions that handle the Event that's used in event callbacks.

I will create a POC for this issue with a renamed variant in the meantime. But it may be a good idea to address this before #2060 is finished. I've read somewhere that v1.0.0 will be coming soon, so it may be good to include it there.

[amrbashir]

@Chaostheorie yeah we definitely need to fix this before v1.

I think we decided internally that Event will be RunEvent because it used in App::run and EmittedEvent will be just Event and exported.

[Chaostheorie]

@amrbashir That sounds awesome. I'm really looking forward to the new release.

Sidenote: RunEvent is already used by the runtime. Maybe call it AppEvent or add runtime::RunEvent to Event. Though you, and the team, most likely knew that anyway.

[amrbashir]

I will move the discussion to your PR