refactor: add methods and implement traits for FilePath and SafeFilePath (tauri-apps#1727)

* refactor: add methods and implement traits for `FilePath` and `SafeFilePath`

closes tauri-apps#1726

* clippy

* path -> as_path

* fix prettierignore

* Discard changes to Cargo.lock

* Discard changes to Cargo.toml

* update tauri deps

Author: amrbashir

.changes/fs-dialog-file-path-methods.md

@@ -0,0 +1,10 @@
+---
+"fs": patch
+"dialog": patch
+---
+
+Add utility methods on `FilePath` and `SafeFilePath` enums which are:
+
+- `path`
+- `simplified`
+- `into_path`

.changes/fs-dialog-file-path-traits.md

@@ -0,0 +1,6 @@
+---
+"fs": patch
+"dialog": patch
+---
+
+Implement `Serialize`, `Deserialize`, `From`, `TryFrom` and `FromStr` traits for `FilePath` and `SafeFilePath` enums.

.changes/fs-dialog-non-exhaustive-error.md

@@ -0,0 +1,6 @@
+---
+"fs": patch
+"dialog": patch
+---
+
+Mark `Error` enum as `#[non_exhuastive]`.

.changes/fs-dialog-safe-file-path.md

@@ -0,0 +1,6 @@
+---
+"fs": patch
+"dialog": patch
+---
+
+Add `SafeFilePath` enum.

.prettierignore

@@ -12,7 +12,7 @@ pnpm-lock.yaml
 
 # examples gen directory
 examples/*/src-tauri/gen/
-plugins/examples/*/src-tauri/gen/
+plugins/*/examples/*/src-tauri/gen/
 
 # autogenerated files
 **/autogenerated/**/*.md

Cargo.lock

@@ -26,7 +26,6 @@ serde_json = { workspace = true }
 tauri = { workspace = true }
 log = { workspace = true }
 thiserror = { workspace = true }
-dunce = { workspace = true }
 url = { workspace = true }
 tauri-plugin-fs = { path = "../fs", version = "2.0.0-rc.2" }
 

plugins/dialog/Cargo.toml

@@ -136,7 +136,7 @@ pub(crate) async fn open<R: Runtime>(
                 let folders = dialog_builder.blocking_pick_folders();
                 if let Some(folders) = &folders {
                     for folder in folders {
-                        if let Ok(path) = folder.path() {
+                        if let Ok(path) = folder.clone().into_path() {
                             if let Some(s) = window.try_fs_scope() {
                                 s.allow_directory(path, options.recursive);
                             }
@@ -149,7 +149,7 @@ pub(crate) async fn open<R: Runtime>(
             } else {
                 let folder = dialog_builder.blocking_pick_folder();
                 if let Some(folder) = &folder {
-                    if let Ok(path) = folder.path() {
+                    if let Ok(path) = folder.clone().into_path() {
                         if let Some(s) = window.try_fs_scope() {
                             s.allow_directory(path, options.recursive);
                         }
@@ -164,7 +164,7 @@ pub(crate) async fn open<R: Runtime>(
         let files = dialog_builder.blocking_pick_files();
         if let Some(files) = &files {
             for file in files {
-                if let Ok(path) = file.path() {
+                if let Ok(path) = file.clone().into_path() {
                     if let Some(s) = window.try_fs_scope() {
                         s.allow_file(&path);
                     }
@@ -178,7 +178,7 @@ pub(crate) async fn open<R: Runtime>(
         let file = dialog_builder.blocking_pick_file();
 
         if let Some(file) = &file {
-            if let Ok(path) = file.path() {
+            if let Ok(path) = file.clone().into_path() {
                 if let Some(s) = window.try_fs_scope() {
                     s.allow_file(&path);
                 }
@@ -218,7 +218,7 @@ pub(crate) async fn save<R: Runtime>(
 
     let path = dialog_builder.blocking_save_file();
     if let Some(p) = &path {
-        if let Ok(path) = p.path() {
+        if let Ok(path) = p.clone().into_path() {
             if let Some(s) = window.try_fs_scope() {
                 s.allow_file(&path);
             }

plugins/dialog/src/commands.rs

@@ -7,6 +7,7 @@ use serde::{ser::Serializer, Serialize};
 pub type Result<T> = std::result::Result<T, Error>;
 
 #[derive(Debug, thiserror::Error)]
+#[non_exhaustive]
 pub enum Error {
     #[error(transparent)]
     Tauri(#[from] tauri::Error),
@@ -20,8 +21,6 @@ pub enum Error {
     FolderPickerNotImplemented,
     #[error(transparent)]
     Fs(#[from] tauri_plugin_fs::Error),
-    #[error("URL is not a valid path")]
-    InvalidPathUrl,
 }
 
 impl Serialize for Error {

plugins/dialog/src/error.rs

@@ -11,7 +11,7 @@
     html_favicon_url = "https://github.com/tauri-apps/tauri/raw/dev/app-icon.png"
 )]
 
-use serde::{Deserialize, Serialize};
+use serde::Serialize;
 use tauri::{
     plugin::{Builder, TauriPlugin},
     Manager, Runtime,
@@ -24,6 +24,7 @@ use std::{
 
 pub use models::*;
 
+pub use tauri_plugin_fs::FilePath;
 #[cfg(desktop)]
 mod desktop;
 #[cfg(mobile)]
@@ -294,57 +295,6 @@ impl<R: Runtime> MessageDialogBuilder<R> {
         blocking_fn!(self, show)
     }
 }
-
-/// Represents either a filesystem path or a URI pointing to a file
-/// such as `file://` URIs or Android `content://` URIs.
-#[derive(Debug, Deserialize, Serialize)]
-#[serde(untagged)]
-pub enum FilePath {
-    Url(url::Url),
-    Path(PathBuf),
-}
-
-impl From<PathBuf> for FilePath {
-    fn from(value: PathBuf) -> Self {
-        Self::Path(value)
-    }
-}
-
-impl From<url::Url> for FilePath {
-    fn from(value: url::Url) -> Self {
-        Self::Url(value)
-    }
-}
-
-impl From<FilePath> for tauri_plugin_fs::FilePath {
-    fn from(value: FilePath) -> Self {
-        match value {
-            FilePath::Path(p) => tauri_plugin_fs::FilePath::Path(p),
-            FilePath::Url(url) => tauri_plugin_fs::FilePath::Url(url),
-        }
-    }
-}
-
-impl FilePath {
-    fn simplified(self) -> Self {
-        match self {
-            Self::Url(url) => Self::Url(url),
-            Self::Path(p) => Self::Path(dunce::simplified(&p).to_path_buf()),
-        }
-    }
-
-    #[inline]
-    fn path(&self) -> Result<PathBuf> {
-        match self {
-            Self::Url(url) => url
-                .to_file_path()
-                .map(PathBuf::from)
-                .map_err(|_| Error::InvalidPathUrl),
-            Self::Path(p) => Ok(p.to_owned()),
-        }
-    }
-}
-
 #[derive(Debug, Serialize)]
 pub(crate) struct Filter {
     pub name: String,