tauri-plugin-android-fs 29.0.0

use serde::{Deserialize, Serialize};
use crate::*;


/// Storage volume metadata
/// 
/// # Serialization
/// Serialized by `serde` as the following TypeScript type:
///
/// ```ts
/// type StorageVolume = {
///     description: string,
///     isPrimary: boolean,
///     isRemovable: boolean,
///     isStable: boolean,
///     isEmulated: boolean,
///     isReadonly: boolean,
///     isAvailableForAppStorage: boolean,
///     isAvailableForPublicStorage: boolean,
///     id: StorageVolumeId
/// };
/// 
/// type StorageVolumeId = unknown;
/// ```
#[derive(Debug, Clone, Hash, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct StorageVolume {

    /// A user-visible description of the volume.  
    /// This can be determined by the manufacturer and is often localized according to the user’s language.
    ///
    /// e.g.
    /// - `Internal shared storage`
    /// - `SDCARD`
    /// - `SD card`
    /// - `Virtual SD card`
    pub description: String,

    /// Indicates whether this is primary storage volume. 
    /// A device always has one (and one only) primary storage volume. 
    pub is_primary: bool,

    /// Indicates whether this is physically removable.
    /// If `false`, this is device's built-in storage.
    pub is_removable: bool,

    /// Indicates whether thit is stable part of the device.
    /// 
    /// For example, a device’s built-in storage and physical media slots under protective covers are considered stable, 
    /// while USB flash drives connected to handheld devices are not.
    pub is_stable: bool,

    /// Indicates whether this is backed by private user data partition, 
    /// either internal storage or [adopted storage](https://source.android.com/docs/core/storage/adoptable).
    ///
    /// On most recent devices, the primary storage volume will often have this set to `true`.
    pub is_emulated: bool,

    /// Indicates whether this is readonly storage volume.
    ///
    /// e.g. SD card with readonly mode.
    /// 
    /// # Remark
    /// As far as I understand, this should never be `true` 
    /// when either `is_primary` or `is_emulated` is true, 
    /// or when `is_removable` is false, 
    /// but it might not be the case due to any issues or rare cases.
    pub is_readonly: bool,

    pub is_available_for_app_storage: bool,

    pub is_available_for_public_storage: bool,

    pub id: StorageVolumeId
}

#[derive(Debug, Clone, Hash, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct StorageVolumeId {
    /// これは常に存在すると期待していい。
    pub(crate) top_dir_path: Option<std::path::PathBuf>,

    /// USB drive などの一時的な storage volume の場合は存在しない。
    pub(crate) app_data_dir_path: Option<std::path::PathBuf>,

    /// USB drive などの一時的な storage volume の場合は存在しない。
    pub(crate) app_cache_dir_path: Option<std::path::PathBuf>,

    /// USB drive などの一時的な storage volume の場合は存在しない。
    pub(crate) app_media_dir_path: Option<std::path::PathBuf>,

    /// 常に存在するとは限らない。
    /// primary storage volume はこれが None になることが多い。
    pub(crate) uid: Option<String>,

    /// None の場合は primary storage volume を指す。
    /// None でないから primary storage volume でないとは限らない。
    /// Android 9 以下は常に None。
    pub(crate) media_store_volume_name: Option<String>,

    /// 常に存在するとは限らない。
    /// Android 11 以下は常に None。
    pub(crate) storage_uuid: Option<String>,
}

#[allow(unused)]
impl StorageVolumeId {

    pub(crate) fn app_dir_path(&self, dir: impl Into<AppDir>) -> Option<&std::path::PathBuf> {
        match dir.into() {
            AppDir::Data => self.app_data_dir_path.as_ref(),
            AppDir::Cache => self.app_cache_dir_path.as_ref(),

            #[allow(deprecated)]
            AppDir::PublicMedia => self.app_media_dir_path.as_ref()
        }
    }
}