Struct TempDirectoryBuilder 

pub struct TempDirectoryBuilder { /* private fields */ }

A temporary directory builder that contains a list of entries to be created.

Examples

use temp_dir_builder::TempDirectoryBuilder;
let temp_dir = TempDirectoryBuilder::default()
    .add_text_file("test/foo.txt", "bar")
    .add_binary_file("test/foo2.txt", &[98u8, 97u8, 114u8])
    .add_empty_file("test/folder-a/folder-b/bar.txt")
    .add_file("test/file.rs", file!())
    .add_directory("test/dir")
    .build()
    .expect("create temp dir");
println!("created successfully in {}", temp_dir.path().display());

Implementations

impl TempDirectoryBuilder

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

Sets the root folder where the tree will be created.
By default this is the temporary directory path returned by std::env::temp_dir().

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

Specifies whether to automatically delete the temporary folder when the TempDirectory instance is dropped.
By default this is value is set to true.

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

Adds an empty file.

• path - Path of the file to create. This path must be relative to the created directory. If the path is outside the created directory (e.g: “../foo”) the error BuildError::EntryOutsideDirectory will be returned.

Examples found in repository

examples/builder.rs (line 6)

fn main() {
    let temp_directory = TempDirectoryBuilder::default()
        .add_text_file("test/foo.txt", "bar")
        .add_empty_file("test/folder-a/folder-b/bar.txt")
        .add_file("test_file.rs", file!())
        .build()
        .expect("create tree fs");

    println!(
        "created successfully in {}",
        temp_directory.path().display()
    );

    let path = temp_directory.path().to_path_buf();

    assert!(path.exists());

    drop(temp_directory);

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

pub fn add_directory(self, path: impl AsRef<Path>) -> Self

Adds a directory.

• path - Path of the directory to create. This path must be relative to the created directory. If the path is outside the created directory (e.g: “../foo”) the error BuildError::EntryOutsideDirectory will be returned.

pub fn add_text_file(self, path: impl AsRef<Path>, text: impl ToString) -> Self

Adds a text file specifying the content.

• path - Path of the text file to create. This path must be relative to the created directory. If the path is outside the created directory (e.g: “../foo”) the error BuildError::EntryOutsideDirectory will be returned.
• text - Text to be written in the new file created.

Examples found in repository

examples/builder.rs (line 5)

fn main() {
    let temp_directory = TempDirectoryBuilder::default()
        .add_text_file("test/foo.txt", "bar")
        .add_empty_file("test/folder-a/folder-b/bar.txt")
        .add_file("test_file.rs", file!())
        .build()
        .expect("create tree fs");

    println!(
        "created successfully in {}",
        temp_directory.path().display()
    );

    let path = temp_directory.path().to_path_buf();

    assert!(path.exists());

    drop(temp_directory);

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

pub fn add_binary_file(self, path: impl AsRef<Path>, content: &[u8]) -> Self

Adds a binary file specifying the content.

• path - Path of the binary file to create. This path must be relative to the created directory. If the path is outside the created directory (e.g: “../foo”) the error BuildError::EntryOutsideDirectory will be returned.
• content - The bytes to be written in the new file created.

pub fn add_file(self, path: impl AsRef<Path>, file: impl AsRef<Path>) -> Self

Adds a file specifying a source file to be copied.

• path - Path of the file to create. This path must be relative to the created directory. If the path is outside the created directory (e.g: “../foo”) the error BuildError::EntryOutsideDirectory will be returned.
• file - Path of the file to be copied. This path must be absolute.

Examples found in repository

examples/builder.rs (line 7)

fn main() {
    let temp_directory = TempDirectoryBuilder::default()
        .add_text_file("test/foo.txt", "bar")
        .add_empty_file("test/folder-a/folder-b/bar.txt")
        .add_file("test_file.rs", file!())
        .build()
        .expect("create tree fs");

    println!(
        "created successfully in {}",
        temp_directory.path().display()
    );

    let path = temp_directory.path().to_path_buf();

    assert!(path.exists());

    drop(temp_directory);

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

pub fn build(&self) -> Result<TempDirectory, BuildError>

Builds the file tree by generating files and directories based on the list of Entrys.

Errors

A BuildError is returned in case of error.

Examples found in repository

examples/builder.rs (line 8)

fn main() {
    let temp_directory = TempDirectoryBuilder::default()
        .add_text_file("test/foo.txt", "bar")
        .add_empty_file("test/folder-a/folder-b/bar.txt")
        .add_file("test_file.rs", file!())
        .build()
        .expect("create tree fs");

    println!(
        "created successfully in {}",
        temp_directory.path().display()
    );

    let path = temp_directory.path().to_path_buf();

    assert!(path.exists());

    drop(temp_directory);

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

Trait Implementations

impl Debug for TempDirectoryBuilder

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

Formats the value using the given formatter.

impl Default for TempDirectoryBuilder

fn default() -> Self

Creates a default TempDirectoryBuilder instance with an empty file list,