Struct tauri::ipc::JavaScriptChannelId

pub struct JavaScriptChannelId(/* private fields */);

The ID of a channel that was defined on the JavaScript layer.

Useful when expecting Channel as part of a JSON object instead of a top-level command argument.

Examples

use tauri::{ipc::JavaScriptChannelId, Runtime, Webview};

#[derive(serde::Deserialize)]
#[serde(rename_all = "camelCase")]
struct Button {
  label: String,
  on_click: JavaScriptChannelId,
}

#[tauri::command]
fn add_button<R: Runtime>(webview: Webview<R>, button: Button) {
  let channel = button.on_click.channel_on(webview);
  channel.send("clicked").unwrap();
}

Implementations

impl JavaScriptChannelId

pub fn channel_on<R: Runtime>(&self, webview: Webview<R>) -> Channel

Gets a Channel for this channel ID on the given Webview.

Trait Implementations

impl<'de> Deserialize<'de> for JavaScriptChannelId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for JavaScriptChannelId

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.