damascus 0.0.11

filesystem utility crate for the Flamberge mod manager stack
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

# Damascus

[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/Yato202010/Damascus)](https://github.com/Yato202010/Damascus/issues)
[![GitHub License](https://img.shields.io/github/license/Yato202010/Damascus)](https://github.com/Yato202010/Damascus/blob/main/LICENSE)
[![docs.rs](https://img.shields.io/docsrs/damascus)](https://docs.rs/damascus/latest/damascus/)
[![Crates.io Version](https://img.shields.io/crates/v/damascus)](https://crates.io/crates/damascus)
![Crates.io MSRV](https://img.shields.io/crates/msrv/Damascus)
[![Matrix](https://img.shields.io/badge/Matrix-Join%20Chat-000000?logo=matrix&logoColor=white)](https://matrix.to/#/#flamberge-mo:matrix.org)

Damascus is a utility crate focused on providing a simple way to interact
with filesystem from rust

## Supported system

| System | Status       | Available Handle          |
| ------ | ------------ | ------------------------- |
| Window | Unsupported  | /                         |
| Linux  | Supported    | OverlayFs , FuseOverlayFs |
| Linux  | Experimental | UnionFsFuse               |
| MacOS  | Unsupported  | /                         |

## How to use?

```rust
use std::path::Path;
use damascus::{Filesystem, FuseOverlayFs, FuseOverlayFsOption, StateRecovery};
use temp_testdir::TempDir;
use std::fs::create_dir_all;

fn main() {
    let tmp = TempDir::default().to_path_buf();
    let lower1 = tmp.join("lowest_layer");
    let lower2 = tmp.join("lower_layer");
    let upper = tmp.join("upper_layer");
    let work = tmp.join("working");
    let target = tmp.join("mount_target");
    let drop = true;
    create_dir_all(&lower1).unwrap();
    create_dir_all(&lower2).unwrap();
    create_dir_all(&upper).unwrap();
    create_dir_all(&work).unwrap();
    create_dir_all(&target).unwrap();

    // handle can be created using complex or simple interface based on need
    // NOTE : drop control if once dropped the filesystem should be unmounted ie scoped mount
    let mut o = FuseOverlayFs::new(
        [&lower1, &lower2],
        Some(&upper),
        Some(&work),
        &target,
        drop,
    )
    .unwrap();
    // or
    o = FuseOverlayFs::writable([&lower1, &lower2], upper, work, &target).unwrap();
    // or
    o = FuseOverlayFs::readonly([&lower1, &lower2], &target).unwrap();

    o.add_option(FuseOverlayFsOption::CloneFd).unwrap();
    o.set_scoped(false); // true by default

    // once configured you can mount it
    o.mount().unwrap();

    // if handle is lost it can be recovered from system information
    let recovered = FuseOverlayFs::recover(target).unwrap();

    // and then unmount it
    o.unmount().unwrap();
}
```

## FAQ

- Will you target Windows and MacOS support?
  - In the long run some support may be implemented for those platforms
    as the current implementation leave place for a cross-platform
    support in the future.