tauri_plugin_android_fs/api/
private_storage.rs

1use sync_async::sync_async;
2use crate::*;
3use super::*;
4
5
6/// API of file storage intended for the app’s use only.  
7/// 
8/// # Examples
9/// ```no_run
10/// fn example(app: &tauri::AppHandle) {
11///     use tauri_plugin_android_fs::AndroidFsExt as _;
12/// 
13///     let api = app.android_fs();
14///     let private_storage = api.private_storage();
15/// }
16/// ```
17#[sync_async]
18pub struct PrivateStorage<'a, R: tauri::Runtime> {
19    #[cfg(target_os = "android")]
20    pub(crate) handle: &'a tauri::plugin::PluginHandle<R>,
21
22    #[cfg(not(target_os = "android"))]
23    #[allow(unused)]
24    pub(crate) handle: &'a std::marker::PhantomData<fn() -> R>,
25}
26
27#[cfg(target_os = "android")]
28#[sync_async(
29    use(if_sync) impls::SyncImpls as Impls;
30    use(if_async) impls::AsyncImpls as Impls;
31)]
32impl<'a, R: tauri::Runtime> PrivateStorage<'a, R> {
33    
34    #[always_sync]
35    fn impls(&self) -> Impls<'_, R> {
36        Impls { handle: &self.handle }
37    }
38}
39
40#[sync_async(
41    use(if_async) api_async::{AndroidFs, FileOpener, FilePicker, PublicStorage, WritableStream};
42    use(if_sync) api_sync::{AndroidFs, FileOpener, FilePicker, PublicStorage, WritableStream};
43)]
44impl<'a, R: tauri::Runtime> PrivateStorage<'a, R> {
45
46    /// Get an absolute path of the app-specific directory on the internal storage.  
47    /// App can fully manage entries within this directory.   
48    /// 
49    /// This function does **not** create any directories; it only constructs the path.
50    /// 
51    /// Since these locations may contain files created by other Tauri plugins or webview systems, 
52    /// it is recommended to add a subdirectory with a unique name.
53    ///
54    /// These entries will be deleted when the app is uninstalled and may also be deleted at the user’s initialising request.  
55    /// 
56    /// When using [`PrivateDir::Cache`], the system will automatically delete entries as disk space is needed elsewhere on the device. 
57    /// But you should not rely on this. The cache should be explicitly cleared by yourself.
58    /// 
59    /// The system prevents other apps and user from accessing these locations. 
60    /// In cases where the device is rooted or the user has special permissions, the user may be able to access this.   
61    /// 
62    /// Since the returned paths can change when the app is moved to an [adopted storage](https://source.android.com/docs/core/storage/adoptable), 
63    /// only relative paths should be stored.
64    /// 
65    /// # Note
66    /// This provides a separate area for each user in a multi-user environment.
67    /// 
68    /// # Support
69    /// All Android version.
70    #[maybe_async]
71    pub fn resolve_path(
72        &self, 
73        dir: PrivateDir
74    ) -> Result<std::path::PathBuf> {
75
76        #[cfg(not(target_os = "android"))] {
77            Err(Error::NOT_ANDROID)
78        }
79        #[cfg(target_os = "android")] {
80            self.impls().private_dir_path(dir).map(Clone::clone)
81        }
82    }
83
84    #[maybe_async]
85    #[allow(deprecated)]
86    #[deprecated = "Use `AppStorage::resolve_path` instead"]
87    pub fn resolve_outside_path(
88        &self, 
89        volume_id: Option<&StorageVolumeId>,
90        dir: OutsidePrivateDir
91    ) -> Result<std::path::PathBuf> {
92
93        #[cfg(not(target_os = "android"))] {
94            Err(Error::NOT_ANDROID)
95        }
96        #[cfg(target_os = "android")] {
97            self.impls().resolve_dir_path_in_app_storage(volume_id, dir).await
98        }
99    }
100
101    #[deprecated = "Use `AppStorage::get_volumes` instead"]
102    #[maybe_async]
103    pub fn get_volumes(&self) -> Result<Vec<StorageVolume>> {
104        #[cfg(not(target_os = "android"))] {
105            Err(Error::NOT_ANDROID)
106        }
107        #[cfg(target_os = "android")] {
108            self.impls().get_available_storage_volumes_for_app_storage().await
109        }
110    }
111
112    #[deprecated = "Use `AppStorage::get_primary_volume` instead"]
113    #[maybe_async]
114    pub fn get_primary_volume(&self) -> Result<Option<StorageVolume>> {
115        #[cfg(not(target_os = "android"))] {
116            Err(Error::NOT_ANDROID)
117        }
118        #[cfg(target_os = "android")] {
119            self.impls().get_primary_storage_volume_if_available_for_app_storage().await
120        }
121    }
122
123
124    /// This is same as [`FileUri::from_path`]
125    #[deprecated = "use `FileUri::from_path` instead"]
126    #[maybe_async]
127    pub fn resolve_uri(
128        &self, 
129        dir: PrivateDir,
130        relative_path: impl AsRef<std::path::Path>
131    ) -> Result<FileUri> {
132
133        #[cfg(not(target_os = "android"))] {
134            Err(Error::NOT_ANDROID)
135        }
136        #[cfg(target_os = "android")] {
137            let mut path = self.resolve_path(dir).await?;
138            path.push(relative_path.as_ref());
139            Ok(path.into())
140        }
141    }
142}
tauri_plugin_android_fs/api/private_storage.rs

tauri_plugin_android_fs/api/
private_storage.rs
