opfs 0.3.1

A Rust implementation of the Origin Private File System browser API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

#[cfg(target_arch = "wasm32")]
pub use crate::web::{DirectoryHandle, FileHandle, WritableFileStream};

#[cfg(not(target_arch = "wasm32"))]
pub use crate::native::{DirectoryHandle, FileHandle, WritableFileStream};

#[cfg(not(target_arch = "wasm32"))]
mod native_root;
#[cfg(not(target_arch = "wasm32"))]
pub use native_root::{configure_app, configure_root};

pub type Error = <DirectoryHandle as crate::DirectoryHandle>::Error;
pub type Result<T> = std::result::Result<T, Error>;

/// Returns a directory handle for app-specific data storage.
///
/// On web platforms, this returns the origin's root OPFS directory. No setup is needed.
///
/// Works on the main thread and in Web Workers: the origin's storage is
/// reached through whichever global scope the code is running in.
#[cfg(target_arch = "wasm32")]
pub async fn app_specific_dir() -> Result<DirectoryHandle> {
    use wasm_bindgen::JsCast;
    use wasm_bindgen_futures::JsFuture;
    use web_sys::FileSystemDirectoryHandle;

    let global = js_sys::global();
    let storage = if let Some(window) = global.dyn_ref::<web_sys::Window>() {
        window.navigator().storage()
    } else if let Some(worker) = global.dyn_ref::<web_sys::WorkerGlobalScope>() {
        worker.navigator().storage()
    } else {
        return Err("No window or worker global scope".into());
    };

    let root_directory_handle =
        FileSystemDirectoryHandle::from(JsFuture::from(storage.get_directory()).await?);

    Ok(DirectoryHandle::from(root_directory_handle))
}

/// Returns a directory handle for app-specific data storage.
///
/// Configure native storage once with [`configure_app`] or [`configure_root`]
/// before calling this function. Creates the configured directory if necessary.
/// Returns an error when storage has not been configured; never falls back to
/// the user's shared data directory.
#[cfg(not(target_arch = "wasm32"))]
pub async fn app_specific_dir() -> Result<DirectoryHandle> {
    let root = native_root::configured_root()?;
    tokio::fs::create_dir_all(root).await?;
    Ok(DirectoryHandle::from(root.to_owned()))
}