Skip to main content

JavaScriptChannelId

Struct JavaScriptChannelId 

Source
pub struct JavaScriptChannelId(/* private fields */);
Expand description

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§

Source§

impl JavaScriptChannelId

Source

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

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

Trait Implementations§

Source§

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

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl FromStr for JavaScriptChannelId

Source§

type Err = &'static str

The associated error which can be returned from parsing.
Source§

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

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<'de, D, R> CommandArg<'de, R> for D
where D: Deserialize<'de>, R: Runtime,

Source§

fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>

Derives an instance of Self from the CommandItem. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T