cleanup & polish
This commit is contained in:
Jonas Kruckenberg
parent
ee68fe6b5b
commit
d5fa1c0397
15 changed files with 657 additions and 470 deletions
313
src/dialog.rs
313
src/dialog.rs
|
|
@ -1,13 +1,16 @@
|
|||
use serde::Serialize;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
#[derive(Debug, Clone, Copy, Hash, Serialize)]
|
||||
struct DialogFilter<'a> {
|
||||
extensions: &'a [&'a str],
|
||||
name: &'a str,
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Serialize)]
|
||||
/// The file dialog builder.
|
||||
///
|
||||
/// Constructs file picker dialogs that can select single/multiple files or directories.
|
||||
#[derive(Debug, Default, Clone, Hash, Serialize)]
|
||||
#[serde(rename = "camelCase")]
|
||||
pub struct FileDialogBuilder<'a> {
|
||||
default_path: Option<&'a Path>,
|
||||
|
|
@ -203,31 +206,24 @@ impl<'a> FileDialogBuilder<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Default)]
|
||||
pub enum MessageDialogType {
|
||||
/// Types of message, ask and confirm dialogs.
|
||||
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize)]
|
||||
pub enum MessageDialogKind {
|
||||
#[default]
|
||||
#[serde(rename = "info")]
|
||||
Info,
|
||||
#[serde(rename = "warning")]
|
||||
Warning,
|
||||
#[serde(rename = "error")]
|
||||
Error,
|
||||
}
|
||||
|
||||
impl Serialize for MessageDialogType {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: serde::Serializer,
|
||||
{
|
||||
match self {
|
||||
MessageDialogType::Info => serializer.serialize_str("info"),
|
||||
MessageDialogType::Warning => serializer.serialize_str("warning"),
|
||||
MessageDialogType::Error => serializer.serialize_str("error"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Default, Serialize)]
|
||||
/// A builder for message dialogs.
|
||||
#[derive(Debug, Default, Clone, Copy, Hash, Serialize)]
|
||||
pub struct MessageDialogBuilder<'a> {
|
||||
title: Option<&'a str>,
|
||||
r#type: MessageDialogType,
|
||||
#[serde(rename = "type")]
|
||||
kind: MessageDialogKind,
|
||||
}
|
||||
|
||||
impl<'a> MessageDialogBuilder<'a> {
|
||||
|
|
@ -256,19 +252,19 @@ impl<'a> MessageDialogBuilder<'a> {
|
|||
/// # Example
|
||||
///
|
||||
/// ```rust
|
||||
/// use tauri_sys::dialog::{MessageDialogBuilder,MessageDialogType};
|
||||
/// use tauri_sys::dialog::{MessageDialogBuilder,MessageDialogKind};
|
||||
///
|
||||
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||
/// let _builder = MessageDialogBuilder::new().set_type(MessageDialogType::Error);
|
||||
/// let _builder = MessageDialogBuilder::new().set_kind(MessageDialogKind::Error);
|
||||
/// # Ok(())
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn set_type(&mut self, r#type: MessageDialogType) {
|
||||
self.r#type = r#type;
|
||||
pub fn set_kind(&mut self, r#kind: MessageDialogKind) {
|
||||
self.kind = r#kind;
|
||||
}
|
||||
|
||||
/// Shows a message dialog with an `Ok` button.
|
||||
///
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```rust,no_run
|
||||
|
|
@ -284,7 +280,7 @@ impl<'a> MessageDialogBuilder<'a> {
|
|||
}
|
||||
|
||||
/// Shows a question dialog with `Yes` and `No` buttons.
|
||||
///
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```rust,no_run
|
||||
|
|
@ -302,7 +298,7 @@ impl<'a> MessageDialogBuilder<'a> {
|
|||
}
|
||||
|
||||
/// Shows a question dialog with `Ok` and `Cancel` buttons.
|
||||
///
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```rust,no_run
|
||||
|
|
@ -320,271 +316,6 @@ impl<'a> MessageDialogBuilder<'a> {
|
|||
}
|
||||
}
|
||||
|
||||
// //! User interaction with the file system using dialog boxes.
|
||||
// //!
|
||||
// //! # Example
|
||||
// //!
|
||||
// //! ```rust,no_run
|
||||
// //! use tauri_api::dialog::open;
|
||||
// //!
|
||||
// //! let path = open(None).await;
|
||||
// //! ```
|
||||
// use serde::Serialize;
|
||||
// use std::path::PathBuf;
|
||||
|
||||
// /// Extension filter for the file dialog.
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// let filter = DialogFilter {
|
||||
// /// extension: vec![".jpg", ".jpeg", ".png", ".bmp"],
|
||||
// /// name: "images",
|
||||
// /// };
|
||||
// /// ```
|
||||
// #[derive(Serialize)]
|
||||
// pub struct DialogFilter {
|
||||
// /// Extensions to filter, without a `.` prefix.
|
||||
// pub extensions: Vec<String>,
|
||||
|
||||
// /// Filter name
|
||||
// pub name: String,
|
||||
// }
|
||||
|
||||
// /// Types of a [`message`] dialog.
|
||||
// #[derive(Serialize)]
|
||||
// pub enum MessageDialogType {
|
||||
// Error,
|
||||
// Info,
|
||||
// Warning,
|
||||
// }
|
||||
|
||||
// /// Options for the [`message`] dialog.
|
||||
// #[derive(Serialize)]
|
||||
// pub struct MessageDialogOptions {
|
||||
// /// The title of the dialog. Defaults to the app name.
|
||||
// pub title: Option<String>,
|
||||
|
||||
// /// The type of the dialog. Defaults to MessageDialogType::Info.
|
||||
// #[serde(rename(serialize = "type"))]
|
||||
// pub kind: MessageDialogType,
|
||||
// }
|
||||
|
||||
// impl MessageDialogOptions {
|
||||
// /// Creates a new `MessageDialogOptions` with sensible default values.
|
||||
// pub fn new() -> Self {
|
||||
// Self {
|
||||
// title: None,
|
||||
// kind: MessageDialogType::Info,
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
|
||||
// /// Options for an [`open`] dialog.
|
||||
// #[derive(Serialize)]
|
||||
// pub struct OpenDialogOptions {
|
||||
// /// Initial directory or file path.
|
||||
// #[serde(rename(serialize = "defaultPath"))]
|
||||
// pub default_path: Option<PathBuf>,
|
||||
|
||||
// /// Whether the dialog is a directory selection or not.
|
||||
// pub directory: bool,
|
||||
|
||||
// /// The filters of the dialog.
|
||||
// pub filters: Vec<DialogFilter>,
|
||||
|
||||
// /// Whether the dialog allows multiple selection or not.
|
||||
// pub multiple: bool,
|
||||
|
||||
// /// If `directory` is `true`, indicatees that it will be read recursivley later.
|
||||
// /// Defines whether subdirectories will be allowed on the scope or not.
|
||||
// pub recursive: bool,
|
||||
|
||||
// /// The title of the dialog window.
|
||||
// pub title: Option<String>,
|
||||
// }
|
||||
|
||||
// impl OpenDialogOptions {
|
||||
// /// Creates a new `OpenDialogOptions` with sensible default values.
|
||||
// pub fn new() -> Self {
|
||||
// Self {
|
||||
// default_path: None,
|
||||
// directory: false,
|
||||
// filters: Vec::new(),
|
||||
// multiple: false,
|
||||
// recursive: false,
|
||||
// title: None,
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
|
||||
// /// Options for the save dialog.
|
||||
// #[derive(Serialize)]
|
||||
// pub struct SaveDialogOptions {
|
||||
// /// Initial directory of the file path.
|
||||
// /// If it's not a directory path, the dialog interface will change to that folder.
|
||||
// /// If it's not an existing directory, the file name will be set to the dialog's
|
||||
// /// file name input and the dialog will be set to the parent folder.
|
||||
// #[serde(rename(serialize = "defaultPath"))]
|
||||
// pub default_path: Option<PathBuf>,
|
||||
|
||||
// /// The filters of the dialog.
|
||||
// pub filters: Vec<DialogFilter>,
|
||||
|
||||
// /// The title of the dialog window.
|
||||
// pub title: Option<String>,
|
||||
// }
|
||||
|
||||
// impl SaveDialogOptions {
|
||||
// /// Creates a new `SaveDialogOptions` with sensible default values.
|
||||
// pub fn new() -> Self {
|
||||
// Self {
|
||||
// default_path: None,
|
||||
// filters: Vec::new(),
|
||||
// title: None,
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
|
||||
// /// Show a question dialog with `Yes` and `No` buttons.
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{ask, MessageDialogOptions};
|
||||
// ///
|
||||
// /// let yes = ask("Are you sure?", None).await;
|
||||
// /// ```
|
||||
// /// @param message Message to display.
|
||||
// /// @param options Dialog options.
|
||||
// /// @returns Whether the user selected `Yes` or `No`.
|
||||
// #[inline(always)]
|
||||
// pub async fn ask(message: &str, options: Option<MessageDialogOptions>) -> crate::Result<bool> {
|
||||
// let js_val = inner::ask(message, serde_wasm_bindgen::to_value(&options)?).await?;
|
||||
|
||||
// Ok(serde_wasm_bindgen::from_value(js_val)?)
|
||||
// }
|
||||
|
||||
// /// Shows a question dialog with `Ok` and `Cancel` buttons.
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{confirm, MessageDialogOptions};
|
||||
// ///
|
||||
// /// let confirmed = confirm("Are you sure?", None).await;
|
||||
// /// ```
|
||||
// /// @returns Whether the user selelced `Ok` or `Cancel`.
|
||||
// pub async fn confirm(message: &str, options: Option<MessageDialogOptions>) -> crate::Result<bool> {
|
||||
// let js_val = inner::confirm(message, serde_wasm_bindgen::to_value(&options)?).await?;
|
||||
|
||||
// Ok(serde_wasm_bindgen::from_value(js_val)?)
|
||||
// }
|
||||
|
||||
// /// Shows a message dialog with an `Ok` button.
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{message, MessageDialogOptions};
|
||||
// ///
|
||||
// /// message("Tauri is awesome", None).await;
|
||||
// /// ```
|
||||
// /// @param message Message to display.
|
||||
// /// @param options Dialog options.
|
||||
// /// @returns Promise resolved when user closes the dialog.
|
||||
// pub async fn message(message: &str, options: Option<MessageDialogOptions>) -> crate::Result<()> {
|
||||
// Ok(inner::message(message, serde_wasm_bindgen::to_value(&options)?).await?)
|
||||
// }
|
||||
|
||||
// /// Opens a file/directory selection dialog for a single file.
|
||||
// /// `multiple` field of [`options`](OpenDialogOptions) must be `false`, if provided.
|
||||
// ///
|
||||
// /// The selected paths are added to the filesystem and asset protocol allowlist scopes.
|
||||
// /// When security is mroe important than the ease of use of this API,
|
||||
// /// prefer writing a dedicated command instead.
|
||||
// ///
|
||||
// /// Note that the allowlist scope change is not persisited,
|
||||
// /// so the values are cleared when the applicaiton is restarted.
|
||||
// /// You can save it to the filessytem using the [tauri-plugin-persisted-scope](https://github.com/tauri-apps/tauri-plugin-persisted-scope).
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{open, OpenDialogOptions};
|
||||
// ///
|
||||
// /// let file = open(None).await;
|
||||
// ///
|
||||
// /// let mut opts = OpenDialogOptions::new();
|
||||
// /// opts.directory = true;
|
||||
// /// let dir = open(Some(opts)).await;
|
||||
// /// ```
|
||||
// /// @param options Dialog options.
|
||||
// /// @returns List of file paths, or `None` if user cancelled the dialog.
|
||||
// pub async fn open(options: Option<OpenDialogOptions>) -> crate::Result<Option<PathBuf>> {
|
||||
// let file = inner::open(serde_wasm_bindgen::to_value(&options)?).await?;
|
||||
|
||||
// Ok(serde_wasm_bindgen::from_value(file)?)
|
||||
// }
|
||||
|
||||
// /// Opens a file/directory selection dialog for multiple files.
|
||||
// /// `multiple` field of [`options`](OpenDialogOptions) must be `true`, if provided.
|
||||
// ///
|
||||
// /// The selected paths are added to the filesystem and asset protocol allowlist scopes.
|
||||
// /// When security is mroe important than the ease of use of this API,
|
||||
// /// prefer writing a dedicated command instead.
|
||||
// ///
|
||||
// /// Note that the allowlist scope change is not persisited,
|
||||
// /// so the values are cleared when the applicaiton is restarted.
|
||||
// /// You can save it to the filessytem using the [tauri-plugin-persisted-scope](https://github.com/tauri-apps/tauri-plugin-persisted-scope).
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{open, OpenDialogOptions};
|
||||
// ///
|
||||
// /// let files = open_multiple(None).await;
|
||||
// ///
|
||||
// /// let mut opts = OpenDialogOptions::new();
|
||||
// /// opts.multiple = true;
|
||||
// /// opts.directory = true;
|
||||
// /// let dirs = open(Some(opts)).await;
|
||||
// /// ```
|
||||
// /// @param options Dialog options.
|
||||
// /// @returns List of file paths, or `None` if user cancelled the dialog.
|
||||
// pub async fn open_multiple(
|
||||
// options: Option<OpenDialogOptions>,
|
||||
// ) -> crate::Result<Option<Vec<PathBuf>>> {
|
||||
// let files = inner::open_multiple(serde_wasm_bindgen::to_value(&options)?).await?;
|
||||
|
||||
// Ok(serde_wasm_bindgen::from_value(files)?)
|
||||
// }
|
||||
|
||||
// /// Opens a file/directory save dialog.
|
||||
// ///
|
||||
// /// The selected paths are added to the filesystem and asset protocol allowlist scopes.
|
||||
// /// When security is mroe important than the ease of use of this API,
|
||||
// /// prefer writing a dedicated command instead.
|
||||
// ///
|
||||
// /// Note that the allowlist scope change is not persisited,
|
||||
// /// so the values are cleared when the applicaiton is restarted.
|
||||
// /// You can save it to the filessytem using the [tauri-plugin-persisted-scope](https://github.com/tauri-apps/tauri-plugin-persisted-scope).
|
||||
// ///
|
||||
// /// # Example
|
||||
// ///
|
||||
// /// ```rust,no_run
|
||||
// /// use tauri_api::dialog::{save, SaveDialogOptions};
|
||||
// ///
|
||||
// /// let file = save(None).await;
|
||||
// /// ```
|
||||
// /// @param options Dialog options.
|
||||
// /// @returns File path, or `None` if user cancelled the dialog.
|
||||
// pub async fn save(options: Option<SaveDialogOptions>) -> crate::Result<Option<PathBuf>> {
|
||||
// let path = inner::save(serde_wasm_bindgen::to_value(&options)?).await?;
|
||||
|
||||
// Ok(serde_wasm_bindgen::from_value(path)?)
|
||||
// }
|
||||
|
||||
mod inner {
|
||||
use wasm_bindgen::{prelude::wasm_bindgen, JsValue};
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue