opfs-project 0.2.9

A Rust library for working with the Origin Private File System (OPFS) in WebAssembly applications
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Central project struct that owns all state.

use std::io::Result;
use std::path::{Path, PathBuf};

use bytes::Bytes;
use tokio_fs_ext::DirEntry;

use crate::config::Config;
use crate::error::OpfsError;
use crate::fuse_fs::FuseFs;
use crate::package_lock::PackageLock;
use crate::package_manager::{self, InstallOptions};
use crate::store::Store;

/// The main API entry point for opfs-project.
///
/// Owns all state: caches, config, store, and the current working directory.
/// Instances are typically created once and shared behind an `Arc` or `RwLock`.
pub struct OpfsProject {
    config: Config,
    fuse_fs: FuseFs,
    store: Store,
}

impl Default for OpfsProject {
    fn default() -> Self {
        Self::new(Config::default())
    }
}

impl OpfsProject {
    /// Create a new project with the given config.
    pub fn new(config: Config) -> Self {
        let fuse_fs = FuseFs::new(config.fuse_cache_max_entries);
        let store = Store::new(&config);
        Self {
            config,
            fuse_fs,
            store,
        }
    }

    // ── cwd ──────────────────────────────────────────────────────────

    /// Set the current working directory.
    ///
    /// Delegates to `tokio_fs_ext::set_current_dir` so that all code paths
    /// (including those outside `OpfsProject`) see the same cwd.
    pub fn set_cwd(&self, path: impl AsRef<Path>) {
        tokio_fs_ext::set_current_dir(path).expect("failed to set current directory");
    }

    /// Get the current working directory.
    pub fn cwd(&self) -> PathBuf {
        tokio_fs_ext::current_dir().expect("failed to get current directory")
    }

    // ── path preparation ─────────────────────────────────────────────

    fn prepare_path(&self, path: &Path) -> PathBuf {
        if path.starts_with("/") {
            path.to_path_buf()
        } else {
            let cwd = self.cwd();
            if let Ok(stripped) = path.strip_prefix(".") {
                cwd.join(stripped)
            } else {
                cwd.join(path)
            }
        }
    }

    // ── fuse-aware reads ─────────────────────────────────────────────

    /// Read file content, transparently resolving fuse links.
    pub async fn read(&self, path: impl AsRef<Path>) -> Result<Bytes> {
        let prepared = self.prepare_path(path.as_ref());

        if let Some(content) = self.fuse_fs.try_read(&prepared).await? {
            return Ok(content);
        }

        let raw = tokio_fs_ext::read(&prepared).await?;
        Ok(Bytes::from(raw))
    }

    /// Read directory contents, transparently merging fuse-link entries.
    pub async fn read_dir(&self, path: impl AsRef<Path>) -> Result<Vec<DirEntry>> {
        let prepared = self.prepare_path(path.as_ref());

        if let Some(entries) = self.fuse_fs.try_read_dir(&prepared).await? {
            return Ok(entries);
        }

        tokio_fs_ext::read_dir(&prepared).await?.collect()
    }

    /// Get file/directory metadata, transparently resolving fuse links.
    pub async fn metadata(&self, path: impl AsRef<Path>) -> Result<tokio_fs_ext::Metadata> {
        let prepared = self.prepare_path(path.as_ref());

        if let Some(meta) = self.fuse_fs.try_metadata(&prepared).await? {
            return Ok(meta);
        }

        tokio_fs_ext::metadata(&prepared).await
    }

    // ── package management ───────────────────────────────────────────

    /// Install packages from a parsed `PackageLock`.
    pub async fn install(
        &self,
        lock: &PackageLock,
        opts: &InstallOptions,
    ) -> std::result::Result<(), OpfsError> {
        package_manager::install(self, lock, opts).await
    }

    // ── accessors for internal subsystems ─────────────────────────────

    pub fn config(&self) -> &Config {
        &self.config
    }

    pub fn store(&self) -> &Store {
        &self.store
    }

    pub fn fuse_fs(&self) -> &FuseFs {
        &self.fuse_fs
    }
}