dir-structure 0.3.0

Model directory structures as plain Rust structs.
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

//! A simple example of reading and writing a directory structure from disk, using the [`FsVfs`] VFS.

use std::fs;
use std::pin::Pin;

use dir_structure::prelude::*;
use dir_structure::vfs::fs_vfs::FsVfs;

mod example_dirs;

#[derive(dir_structure::DirStructure)]
struct Dir {
    #[dir_structure(path = "input.txt")]
    input: String,
    #[dir_structure(path = "output.txt")]
    output: String,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // reading example
    let path = example_dirs::get_example_dir_path("reading");
    let vfs = FsVfs;

    // either
    let dir = Dir::read_from(path.as_ref(), Pin::new(&vfs))?;
    // or as a shorthand
    let dir = vfs.read_typed::<Dir>(&path)?;

    println!("input: {}", dir.input);
    println!("output: {}", dir.output);

    // writing example

    let write_path = example_dirs::get_example_dir_path("temp_writing");

    // either
    dir.write_to(write_path.as_ref(), Pin::new(&vfs))?;
    // or as a shorthand
    vfs.write_typed(&write_path, &dir)?;

    assert_eq!(fs::read_to_string(write_path.join("input.txt"))?, dir.input);
    assert_eq!(
        fs::read_to_string(write_path.join("output.txt"))?,
        dir.output
    );

    Ok(())
}