Struct TempProject 

pub struct TempProject { /* private fields */ }

A temporary project directory that auto-cleans on drop.

Holds an internal tempfile::TempDir. The temp directory is deleted when this value is dropped.

Example

use dev_fixtures::TempProject;

let p = TempProject::new()
    .with_file("README.md", "hello")
    .build()
    .unwrap();
assert!(p.path().join("README.md").exists());

Implementations

impl TempProject

pub fn new() -> TempProjectBuilder

Begin building a temp project.

Returns a TempProjectBuilder (not Self); call .build() on it to materialize the directory.

Examples found in repository

examples/temp_project.rs (line 17)

fn main() {
    let project = TempProject::new()
        .with_file(
            "Cargo.toml",
            "[package]\nname = \"sample\"\nversion = \"0.1.0\"\n",
        )
        .with_file("src/lib.rs", "pub fn answer() -> u32 { 42 }\n")
        .with_file(
            "README.md",
            "# sample\n\nGenerated by the dev-fixtures example.\n",
        )
        .with_bytes("assets/payload.bin", vec![0u8, 1, 2, 3, 4, 5])
        .build()
        .expect("build temp project");

    println!("temp project root: {}", project.path().display());
    for (rel, bytes) in project.declared_files() {
        let absolute = project.path().join(rel);
        let read_ok = fs::metadata(&absolute).is_ok();
        println!(
            "  {:>4} bytes — declared {:?} — exists on disk: {}",
            bytes.len(),
            rel,
            read_ok
        );
    }

    let kept_root = project.path().to_path_buf();
    drop(project);
    println!(
        "after drop: {} still on disk? {}",
        kept_root.display(),
        kept_root.exists()
    );
}

pub fn path(&self) -> &Path

Path to the root of the temp project.

Examples found in repository

examples/temp_project.rs (line 31)

fn main() {
    let project = TempProject::new()
        .with_file(
            "Cargo.toml",
            "[package]\nname = \"sample\"\nversion = \"0.1.0\"\n",
        )
        .with_file("src/lib.rs", "pub fn answer() -> u32 { 42 }\n")
        .with_file(
            "README.md",
            "# sample\n\nGenerated by the dev-fixtures example.\n",
        )
        .with_bytes("assets/payload.bin", vec![0u8, 1, 2, 3, 4, 5])
        .build()
        .expect("build temp project");

    println!("temp project root: {}", project.path().display());
    for (rel, bytes) in project.declared_files() {
        let absolute = project.path().join(rel);
        let read_ok = fs::metadata(&absolute).is_ok();
        println!(
            "  {:>4} bytes — declared {:?} — exists on disk: {}",
            bytes.len(),
            rel,
            read_ok
        );
    }

    let kept_root = project.path().to_path_buf();
    drop(project);
    println!(
        "after drop: {} still on disk? {}",
        kept_root.display(),
        kept_root.exists()
    );
}

pub fn declared_files(&self) -> impl Iterator<Item = (&Path, &[u8])>

Files declared at build time. Useful for diagnostics.

Examples found in repository

examples/temp_project.rs (line 32)

fn main() {
    let project = TempProject::new()
        .with_file(
            "Cargo.toml",
            "[package]\nname = \"sample\"\nversion = \"0.1.0\"\n",
        )
        .with_file("src/lib.rs", "pub fn answer() -> u32 { 42 }\n")
        .with_file(
            "README.md",
            "# sample\n\nGenerated by the dev-fixtures example.\n",
        )
        .with_bytes("assets/payload.bin", vec![0u8, 1, 2, 3, 4, 5])
        .build()
        .expect("build temp project");

    println!("temp project root: {}", project.path().display());
    for (rel, bytes) in project.declared_files() {
        let absolute = project.path().join(rel);
        let read_ok = fs::metadata(&absolute).is_ok();
        println!(
            "  {:>4} bytes — declared {:?} — exists on disk: {}",
            bytes.len(),
            rel,
            read_ok
        );
    }

    let kept_root = project.path().to_path_buf();
    drop(project);
    println!(
        "after drop: {} still on disk? {}",
        kept_root.display(),
        kept_root.exists()
    );
}