async-tempfile 0.8.0

Automatically deleted async I/O temporary files.
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use crate::tempdir::DIR_PREFIX;
use crate::tempfile::FILE_PREFIX;
use crate::{Error, TempDir, TempFile};
use std::path::PathBuf;

/// A builder for configuring and creating a [`TempFile`].
///
/// Obtain one via [`TempFile::builder`]. The file name is composed as
/// `{prefix}{random}{suffix}`, where the random core is unpredictable and
/// collision-resistant, and the file is created with an exclusive
/// (`O_EXCL`) create so it never clobbers an existing file.
///
/// ## Example
///
/// ```
/// # use async_tempfile::{TempFile, Error};
/// # let _ = tokio_test::block_on(async {
/// let file = TempFile::builder()
///     .prefix("session_")
///     .suffix(".tmp")
///     .dir(std::env::temp_dir())
///     .create()
///     .await?;
///
/// let name = file.file_path().file_name().unwrap().to_string_lossy().into_owned();
/// assert!(name.starts_with("session_"));
/// assert!(name.ends_with(".tmp"));
/// # Ok::<(), Error>(())
/// # });
/// ```
#[derive(Debug, Clone)]
pub struct TempFileBuilder {
    dir: Option<PathBuf>,
    prefix: String,
    suffix: String,
}

impl TempFileBuilder {
    pub(crate) fn new() -> Self {
        Self {
            dir: None,
            prefix: FILE_PREFIX.to_string(),
            suffix: String::new(),
        }
    }

    /// Sets the file name prefix. Defaults to `atmp_`.
    pub fn prefix<S: Into<String>>(mut self, prefix: S) -> Self {
        self.prefix = prefix.into();
        self
    }

    /// Sets the file name suffix (for example a file extension). Defaults to empty.
    pub fn suffix<S: Into<String>>(mut self, suffix: S) -> Self {
        self.suffix = suffix.into();
        self
    }

    /// Sets the directory to create the file in. Defaults to the system
    /// temporary directory ([`std::env::temp_dir`]).
    pub fn dir<P: Into<PathBuf>>(mut self, dir: P) -> Self {
        self.dir = Some(dir.into());
        self
    }

    /// Creates the temporary file with the configured options.
    pub async fn create(self) -> Result<TempFile, Error> {
        let dir = self.dir.unwrap_or_else(std::env::temp_dir);
        TempFile::create_with_affixes(&dir, &self.prefix, &self.suffix).await
    }
}

/// A builder for configuring and creating a [`TempDir`].
///
/// Obtain one via [`TempDir::builder`]. The directory name is composed as
/// `{prefix}{random}{suffix}` with an unpredictable, collision-resistant random
/// core, created with an exclusive create.
///
/// ## Example
///
/// ```
/// # use async_tempfile::{TempDir, Error};
/// # let _ = tokio_test::block_on(async {
/// let dir = TempDir::builder()
///     .prefix("workspace_")
///     .create()
///     .await?;
///
/// let name = dir.dir_path().file_name().unwrap().to_string_lossy().into_owned();
/// assert!(name.starts_with("workspace_"));
/// # Ok::<(), Error>(())
/// # });
/// ```
#[derive(Debug, Clone)]
pub struct TempDirBuilder {
    root: Option<PathBuf>,
    prefix: String,
    suffix: String,
}

impl TempDirBuilder {
    pub(crate) fn new() -> Self {
        Self {
            root: None,
            prefix: DIR_PREFIX.to_string(),
            suffix: String::new(),
        }
    }

    /// Sets the directory name prefix. Defaults to `atmpd_`.
    pub fn prefix<S: Into<String>>(mut self, prefix: S) -> Self {
        self.prefix = prefix.into();
        self
    }

    /// Sets the directory name suffix. Defaults to empty.
    pub fn suffix<S: Into<String>>(mut self, suffix: S) -> Self {
        self.suffix = suffix.into();
        self
    }

    /// Sets the root directory to create the directory in. Defaults to the
    /// system temporary directory ([`std::env::temp_dir`]).
    pub fn dir<P: Into<PathBuf>>(mut self, root: P) -> Self {
        self.root = Some(root.into());
        self
    }

    /// Creates the temporary directory with the configured options.
    pub async fn create(self) -> Result<TempDir, Error> {
        let root = self.root.unwrap_or_else(std::env::temp_dir);
        TempDir::create_with_affixes(&root, &self.prefix, &self.suffix).await
    }
}