From 3e69eed22fdb037033285943fcd2120e33b024e5 Mon Sep 17 00:00:00 2001 From: Jonas Kruckenberg Date: Wed, 16 Nov 2022 13:30:08 +0100 Subject: [PATCH] cleanup --- src/clipboard.rs | 2 -- src/event.rs | 2 -- src/notification.rs | 24 +++++++----------------- src/os.rs | 10 ++++++++++ src/path.rs | 30 ++++++++++++++++++++++++++++++ src/process.rs | 2 ++ src/updater.rs | 2 ++ 7 files changed, 51 insertions(+), 21 deletions(-) diff --git a/src/clipboard.rs b/src/clipboard.rs index 1715f18..27427db 100644 --- a/src/clipboard.rs +++ b/src/clipboard.rs @@ -24,8 +24,6 @@ pub async fn read_text() -> crate::Result { /// write_text("Tauri is awesome!").await; /// assert_eq!(read_text().await, "Tauri is awesome!"); /// ``` -/// -/// @returns A promise indicating the success or failure of the operation. #[inline(always)] pub async fn write_text(text: &str) -> crate::Result<()> { Ok(inner::writeText(text).await?) diff --git a/src/event.rs b/src/event.rs index 9ba40f1..48db53b 100644 --- a/src/event.rs +++ b/src/event.rs @@ -67,7 +67,6 @@ pub async fn emit(event: &str, payload: &T) -> crate::Result<()> { /// /// @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`. /// @param handler Event handler callback. -/// @returns A promise resolving to a function to unlisten to the event. /// /// Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted. #[inline(always)] @@ -112,7 +111,6 @@ where /// ``` /// /// @param event Event name. Must include only alphanumeric characters, `-`, `/`, `:` and `_`. -/// @returns A promise resolving to a function to unlisten to the event. /// /// Note that removing the listener is required if your listener goes out of scope e.g. the component is unmounted. #[inline(always)] diff --git a/src/notification.rs b/src/notification.rs index 5cf0300..b65f958 100644 --- a/src/notification.rs +++ b/src/notification.rs @@ -1,41 +1,30 @@ use serde::{Deserialize, Serialize}; +#[inline(always)] pub async fn is_permission_granted() -> crate::Result { let raw = inner::isPermissionGranted().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } +#[inline(always)] pub async fn request_permission() -> crate::Result { let raw = inner::requestPermission().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } -#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)] +#[derive(Debug, Deserialize, Default, Clone, Copy, PartialEq, Eq)] pub enum Permission { #[default] + #[serde(rename = "default")] Default, + #[serde(rename = "granted")] Granted, + #[serde(rename = "denied")] Denied, } -impl<'de> Deserialize<'de> for Permission { - fn deserialize(deserializer: D) -> Result - where - D: serde::Deserializer<'de>, - { - match String::deserialize(deserializer)?.as_str() { - "default" => Ok(Permission::Default), - "granted" => Ok(Permission::Granted), - "denied" => Ok(Permission::Denied), - _ => Err(serde::de::Error::custom( - "expected one of default, granted, denied", - )), - } - } -} - #[derive(Debug, Default, Serialize)] pub struct Notification<'a> { body: Option<&'a str>, @@ -60,6 +49,7 @@ impl<'a> Notification<'a> { self.icon = Some(icon); } + #[inline(always)] pub fn show(&self) -> crate::Result<()> { inner::sendNotification(serde_wasm_bindgen::to_value(&self)?)?; diff --git a/src/os.rs b/src/os.rs index 6374004..ef6c1ef 100644 --- a/src/os.rs +++ b/src/os.rs @@ -61,30 +61,40 @@ pub enum OsKind { WindowsNt, } +/// Returns the operating system CPU architecture for which the tauri app was compiled. +#[inline(always)] pub async fn arch() -> crate::Result { let raw = inner::arch().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } +/// Returns a string identifying the operating system platform. The value is set at compile time. +#[inline(always)] pub async fn platform() -> crate::Result { let raw = inner::platform().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } +/// Returns the operating system's default directory for temporary files. +#[inline(always)] pub async fn tempdir() -> crate::Result { let raw = inner::tempdir().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } +/// Returns 'OsKind::Linux' on Linux, 'OsKind::Darwin' on macOS, and 'OsKind::WindowsNT' on Windows. +#[inline(always)] pub async fn kind() -> crate::Result { let raw = inner::kind().await?; Ok(serde_wasm_bindgen::from_value(raw)?) } +/// Returns a string identifying the kernel version. +#[inline(always)] pub async fn version() -> crate::Result { let raw = inner::version().await?; diff --git a/src/path.rs b/src/path.rs index 93d9428..94e81df 100644 --- a/src/path.rs +++ b/src/path.rs @@ -14,6 +14,7 @@ use wasm_bindgen::JsValue; /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn app_config_dir() -> crate::Result { let raw = inner::appConfigDir().await?; @@ -33,6 +34,7 @@ pub async fn app_config_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn app_data_dir() -> crate::Result { let raw = inner::appDataDir().await?; @@ -52,6 +54,7 @@ pub async fn app_data_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn app_local_data_dir() -> crate::Result { let raw = inner::appLocalDataDir().await?; @@ -71,6 +74,7 @@ pub async fn app_local_data_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn app_cache_dir() -> crate::Result { let raw = inner::appCacheDir().await?; @@ -95,6 +99,7 @@ pub async fn app_cache_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn audio_dir() -> crate::Result { let raw = inner::audioDir().await?; @@ -119,6 +124,7 @@ pub async fn audio_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn cache_dir() -> crate::Result { let raw = inner::cacheDir().await?; @@ -143,6 +149,7 @@ pub async fn cache_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn config_dir() -> crate::Result { let raw = inner::configDir().await?; @@ -167,6 +174,7 @@ pub async fn config_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn data_dir() -> crate::Result { let raw = inner::dataDir().await?; @@ -191,6 +199,7 @@ pub async fn data_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn desktop_dir() -> crate::Result { let raw = inner::desktopDir().await?; @@ -215,6 +224,7 @@ pub async fn desktop_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn document_dir() -> crate::Result { let raw = inner::documentDir().await?; @@ -239,6 +249,7 @@ pub async fn document_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn download_dir() -> crate::Result { let raw = inner::downloadDir().await?; @@ -263,6 +274,7 @@ pub async fn download_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn executable_dir() -> crate::Result { let raw = inner::executableDir().await?; @@ -287,6 +299,7 @@ pub async fn executable_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn font_dir() -> crate::Result { let raw = inner::fontDir().await?; @@ -311,6 +324,7 @@ pub async fn font_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn home_dir() -> crate::Result { let raw = inner::homeDir().await?; @@ -335,6 +349,7 @@ pub async fn home_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn local_data_dir() -> crate::Result { let raw = inner::localDataDir().await?; @@ -359,6 +374,7 @@ pub async fn local_data_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn picture_dir() -> crate::Result { let raw = inner::pictureDir().await?; @@ -383,6 +399,7 @@ pub async fn picture_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn public_dir() -> crate::Result { let raw = inner::publicDir().await?; @@ -402,6 +419,7 @@ pub async fn public_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn resource_dir() -> crate::Result { let raw = inner::resourceDir().await?; @@ -422,6 +440,7 @@ pub async fn resource_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn resolve_resource(resource_path: &str) -> crate::Result { let raw = inner::resolveResource(JsValue::from_str(resource_path)).await?; @@ -446,6 +465,7 @@ pub async fn resolve_resource(resource_path: &str) -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn runtime_dir() -> crate::Result { let raw = inner::runtimeDir().await?; @@ -470,6 +490,7 @@ pub async fn runtime_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn template_dir() -> crate::Result { let raw = inner::templateDir().await?; @@ -494,6 +515,7 @@ pub async fn template_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn video_dir() -> crate::Result { let raw = inner::videoDir().await?; @@ -518,6 +540,7 @@ pub async fn video_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn app_log_dir() -> crate::Result { let raw = inner::appLogDir().await?; @@ -538,6 +561,7 @@ pub async fn app_log_dir() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn resolve(paths: impl IntoIterator) -> crate::Result { let paths = paths.into_iter(); let raw = inner::resolve(serde_wasm_bindgen::to_value(&paths.collect::>())?).await?; @@ -559,6 +583,7 @@ pub async fn resolve(paths: impl IntoIterator) -> crate::Result crate::Result { let raw = inner::normalize(JsValue::from_str(path)).await?; @@ -579,6 +604,7 @@ pub async fn normalize(path: &str) -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn join(paths: impl IntoIterator) -> crate::Result { let paths = paths.into_iter(); let raw = inner::join(serde_wasm_bindgen::to_value(&paths.collect::>())?).await?; @@ -600,6 +626,7 @@ pub async fn join(paths: impl IntoIterator) -> crate::Result crate::Result { let raw = inner::dirname(JsValue::from_str(path)).await?; @@ -620,6 +647,7 @@ pub async fn dirname(path: &str) -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn extname(path: &str) -> crate::Result { let raw = inner::extname(JsValue::from_str(path)).await?; @@ -642,6 +670,7 @@ pub async fn extname(path: &str) -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn basename(path: &str, ext: Option<&str>) -> crate::Result { let raw = inner::basename( JsValue::from_str(path), @@ -664,6 +693,7 @@ pub async fn basename(path: &str, ext: Option<&str>) -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn is_absolute(path: &str) -> crate::Result { let raw = inner::isAbsolute(JsValue::from_str(path)).await?; diff --git a/src/process.rs b/src/process.rs index 83ac88c..a038eb5 100644 --- a/src/process.rs +++ b/src/process.rs @@ -1,8 +1,10 @@ +#[inline(always)] pub async fn exit(exit_code: u32) -> ! { inner::exit(exit_code).await; unreachable!() } +#[inline(always)] pub fn relaunch() { inner::relaunch(); } diff --git a/src/updater.rs b/src/updater.rs index f879913..7be5bff 100644 --- a/src/updater.rs +++ b/src/updater.rs @@ -43,6 +43,7 @@ pub enum UpdateStatus { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn check_update() -> crate::Result { let raw = inner::checkUpdate().await?; @@ -66,6 +67,7 @@ pub async fn check_update() -> crate::Result { /// # Ok(()) /// # } /// ``` +#[inline(always)] pub async fn install_update() -> crate::Result<()> { inner::installUpdate().await?; Ok(())