Struct TreeBuilder

pub struct TreeBuilder {
    pub root: PathBuf,
    /* private fields */
}

Represents a file tree structure

Examples

use tree_fs::TreeBuilder;
let tree_fs = TreeBuilder::default()
    .add("test/foo.txt", "bar")
    .add_empty("test/folder-a/folder-b/bar.txt")
    .create()
    .expect("create tree fs");
println!("created successfully in {}", tree_fs.root.display());

use tree_fs::TreeBuilder;
let tree_fs = TreeBuilder::default()
     .add("test/foo.txt", "bar")
     .add_empty("test/folder-a/folder-b/bar.txt")
     .drop(true)
     .create()
     .expect("create tree fs");

println!("created successfully in {}", tree_fs.root.display());

let path = tree_fs.root.clone();
assert!(path.exists());

drop(tree_fs);
assert!(!path.exists());

Fields

root: PathBuf

Root folder where the tree will be created.

Implementations

impl TreeBuilder

pub fn root_folder<P: AsRef<Path>>(self, dir: P) -> Self

Sets the root folder where the tree will be created.

pub const fn drop(self, yes: bool) -> Self

Sets the override_file flag, indicating whether existing files should be overridden.

Examples found in repository

examples/drop.rs (line 7)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .drop(true)
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());

    let path = tree_fs.root.clone();
    assert!(path.exists());

    drop(tree_fs);
    assert!(!path.exists());
}

pub const fn override_file(self, yes: bool) -> Self

Sets the override_file flag, indicating whether existing files should be overridden.

pub fn add<P: AsRef<Path>>(self, path: P, content: &str) -> Self

Adds a file with content to the tree.

Examples found in repository

examples/builder.rs (line 5)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());
}

examples/drop.rs (line 5)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .drop(true)
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());

    let path = tree_fs.root.clone();
    assert!(path.exists());

    drop(tree_fs);
    assert!(!path.exists());
}

pub fn add_empty<P: AsRef<Path>>(self, path: P) -> Self

Adds a file with a empty content.

Examples found in repository

examples/builder.rs (line 6)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());
}

examples/drop.rs (line 6)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .drop(true)
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());

    let path = tree_fs.root.clone();
    assert!(path.exists());

    drop(tree_fs);
    assert!(!path.exists());
}

pub fn create(&self) -> Result<Tree>

Creates the file tree by generating files and directories based on the specified metadata.

Errors

Returns an std::io::Result indicating success or failure in creating the file tree.

Examples found in repository

examples/builder.rs (line 7)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());
}

examples/drop.rs (line 8)

fn main() {
    let tree_fs = TreeBuilder::default()
        .add("test/foo.txt", "bar")
        .add_empty("test/folder-a/folder-b/bar.txt")
        .drop(true)
        .create()
        .expect("create tree fs");

    println!("created successfully in {}", tree_fs.root.display());

    let path = tree_fs.root.clone();
    assert!(path.exists());

    drop(tree_fs);
    assert!(!path.exists());
}

Trait Implementations

impl Debug for TreeBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TreeBuilder

fn default() -> Self

Creates a default Tree instance with an empty file list,

impl<'de> Deserialize<'de> for TreeBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.