origin-workspace-fs 0.2.0

WorkspaceFs over the local filesystem: read-only access under user-confirmed roots.
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

# origin-workspace-fs

Workspace filesystem adapter for Origin (`WorkspaceFs`, B2).

Part of [Origin](https://github.com/casoon/origin), a Rust/Tauri platform for building
desktop applications from a shared set of domain crates. See the workspace
[documentation](https://github.com/casoon/origin/tree/main/docs) for how the pieces fit
together, and [ARCHITECTURE.md](https://github.com/casoon/origin/blob/main/ARCHITECTURE.md)
for the rules this crate follows.

## Example

```rust
use origin_platform::{RelPath, WorkspaceFs, WorkspaceRoot};
use origin_workspace_fs::StdWorkspaceFs;

let fs = StdWorkspaceFs::new();
let root = WorkspaceRoot::new("/path/to/project")?;
let path = RelPath::new("src/main.rs")?;

let contents = fs.read_file(&root, &path).await?;
```

Implements read-only filesystem access for workspace repositories. All operations are strictly
confined to user-confirmed `WorkspaceRoot` locations. Path traversal and symlink escapes outside
the root are verified and rejected with permission errors.

## Stability

Pre-1.0 (`0.2.0`). Public types, enums and field sets may still change between minor
versions; pin an exact version if that matters to you.