tauri_plugin_android_fs

Trait PublicStorage

Source 
pub trait PublicStorage<R: Runtime> {
    // Required methods
    fn create_file_in_public_dir(
        &self,
        dir: impl Into<PublicDir>,
        relative_path_with_subdir: impl AsRef<str>,
        mime_type: Option<&str>,
    ) -> Result<FileUri>;
    fn is_audiobooks_dir_available(&self) -> Result<bool>;
    fn is_recordings_dir_available(&self) -> Result<bool>;
    fn app_handle(&self) -> &AppHandle<R>;

    // Provided method
    fn create_file_in_public_app_dir(
        &self,
        dir: impl Into<PublicDir>,
        relative_path: impl AsRef<str>,
        mime_type: Option<&str>,
    ) -> Result<FileUri> { ... }
}
Expand description

File storage intended for the app’s use only.

Required Methods§

Source

fn create_file_in_public_dir( &self, dir: impl Into<PublicDir>, relative_path_with_subdir: impl AsRef<str>, mime_type: Option<&str>, ) -> Result<FileUri>

Creates a new empty file in the specified public directory and returns a persistent read-write-removable URI.

The created file will be registered with the corresponding MediaStore as needed.

§Args

  • dir :
    The base directory.

  • relative_path_with_subdir :
    The file path relative to the base directory.
    If a file with the same name already exists, a sequential number will be appended to ensure uniqueness.
    Any missing subdirectories in the specified path will be created automatically.
    Please specify a subdirectory in this, such as MyApp/file.txt or MyApp/2025-2-11/file.txt. Do not use file.txt.
    It is customary to specify the app name at the beginning of the subdirectory, and in this case, using PublicStorage::create_file_in_public_app_dir is recommended.

  • mime_type :
    The MIME type of the file to be created.
    Specifying this is recommended whenever possible.
    If not provided, application/octet-stream will be used, as generic, unknown, or undefined file types.
    When using PublicImageDir, please use only image MIME types; using other types may cause errors. Similarly, use only the corresponding media types for PublicVideoDir and PublicAudioDir. Only PublicGeneralPurposeDir supports all MIME types.

§Support

Android 10 (API level 29) or higher.
Lower are need runtime request of WRITE_EXTERNAL_STORAGE. (This option will be made available in the future)

PublicAudioDir::Audiobooks is not available on Android 9 (API level 28) and lower. Availability on a given device can be verified by calling PublicStorage::is_audiobooks_dir_available.
PublicAudioDir::Recordings is not available on Android 11 (API level 30) and lower. Availability on a given device can be verified by calling PublicStorage::is_recordings_dir_available.
Others are available in all Android versions.

Source

fn is_audiobooks_dir_available(&self) -> Result<bool>

Verify whether PublicAudioDir::Audiobooks is available on a given device.

§Support

All Android version.

Source

fn is_recordings_dir_available(&self) -> Result<bool>

Verify whether PublicAudioDir::Recordings is available on a given device.

§Support

All Android version.

Source

fn app_handle(&self) -> &AppHandle<R>

Provided Methods§

Source

fn create_file_in_public_app_dir( &self, dir: impl Into<PublicDir>, relative_path: impl AsRef<str>, mime_type: Option<&str>, ) -> Result<FileUri>

Creates a new empty file in the specified public app directory and returns a persistent read-write-removable URI.

The created file will be registered with the corresponding MediaStore as needed.

§Args

  • dir :
    The base directory.

  • relative_path :
    The file path relative to the base directory.
    If a file with the same name already exists, a sequential number will be appended to ensure uniqueness.
    Any missing subdirectories in the specified path will be created automatically.

  • mime_type :
    The MIME type of the file to be created.
    Specifying this is recommended whenever possible.
    If not provided, application/octet-stream will be used, as generic, unknown, or undefined file types.
    When using PublicImageDir, please use only image MIME types; using other types may cause errors. Similarly, use only the corresponding media types for PublicVideoDir and PublicAudioDir. Only PublicGeneralPurposeDir supports all MIME types.

§Support

Android 10 (API level 29) or higher.
Lower are need runtime request of WRITE_EXTERNAL_STORAGE. (This option will be made available in the future)

PublicAudioDir::Audiobooks is not available on Android 9 (API level 28) and lower. Availability on a given device can be verified by calling PublicStorage::is_audiobooks_dir_available.
PublicAudioDir::Recordings is not available on Android 11 (API level 30) and lower. Availability on a given device can be verified by calling PublicStorage::is_recordings_dir_available.
Others are available in all Android versions.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§