Crate outdir_tempdir

source ·
Expand description

OUTDIR-TEMPDIR

A crate for cargo-test to create temporary directories.
The temporary directories are always created in the OUT_DIR.

Usage

Add dependency to your Cargo.toml.

[dev-dependencies]
outdir-tempdir = "0.2"

Examples

Create a temporary directory with automatic removal.

#[test]
fn test_something() {
    // Create a randomly named temporary directory
    // and automatically remove it upon dropping
    let dir = TempDir::new().autorm();

    // Get temporary directory
    // (/path/to/crate/target/(debug|release)/build/outdir-tempdir-<random>/out/test-<random>)
    let tempdir = dir.path();

    // Test your code using `tempdir`
    // ...

    // Remove the temporary directory when the `dir` variable is dropped
}

Create a temporary directory without automatic removal.

#[test]
fn test_something() {
    // Create a randomly named temporary directory
    let dir = TempDir::new();

    // Get temporary directory
    // (/path/to/crate/target/(debug|release)/build/outdir-tempdir-<random>/out/test-<random>)
    let tempdir = dir.path();

    // Test your code using `tempdir`
    // ...

    // The temporary directory will not be deleted even when the `dir` variable is dropped
}

Create a temporary directory using the specified path.

#[test]
fn test_something() {
    // Create a temporary directory with a specified path 'foo/bar/baz'
    // and automatically remove it upon dropping
    let dir = TempDir::with_path("foo/bar/baz").autorm();

    // Get temporary directory
    // (/path/to/crate/target/(debug|release)/build/outdir-tempdir-<random>/out/foo/bar/baz)
    let tempdir = dir.path();

    // Test your code using `tempdir`
    // ...

    // Remove the temporary directory when the `dir` variable is dropped
}

Structs

  • TempDir
    Provides a function to creating a temporary directory that will be automatically removed upon being dropped.

Enums

  • Error
    Enum listing possible errors from outdir-tempdir.

Type Aliases