-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add stored parent_dir builder parameter #308
Open
bjackman
wants to merge
1
commit into
Stebalien:master
Choose a base branch
from
bjackman:builder-tempdir-in
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -171,29 +171,31 @@ pub use crate::spooled::{spooled_tempfile, SpooledData, SpooledTempFile}; | |||||
|
||||||
/// Create a new temporary file or directory with custom parameters. | ||||||
#[derive(Debug, Clone, Eq, PartialEq)] | ||||||
pub struct Builder<'a, 'b> { | ||||||
pub struct Builder<'a, 'b, 'c> { | ||||||
random_len: usize, | ||||||
prefix: &'a OsStr, | ||||||
suffix: &'b OsStr, | ||||||
dir: Option<&'c Path>, | ||||||
append: bool, | ||||||
permissions: Option<std::fs::Permissions>, | ||||||
keep: bool, | ||||||
} | ||||||
|
||||||
impl<'a, 'b> Default for Builder<'a, 'b> { | ||||||
impl<'a, 'b, 'c> Default for Builder<'a, 'b, 'c> { | ||||||
fn default() -> Self { | ||||||
Builder { | ||||||
random_len: crate::NUM_RAND_CHARS, | ||||||
prefix: OsStr::new(".tmp"), | ||||||
suffix: OsStr::new(""), | ||||||
dir: None, // Use env::temp_dir(). | ||||||
append: false, | ||||||
permissions: None, | ||||||
keep: false, | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
impl<'a, 'b> Builder<'a, 'b> { | ||||||
impl<'a, 'b, 'c> Builder<'a, 'b, 'c> { | ||||||
/// Create a new `Builder`. | ||||||
/// | ||||||
/// # Examples | ||||||
|
@@ -304,6 +306,28 @@ impl<'a, 'b> Builder<'a, 'b> { | |||||
self | ||||||
} | ||||||
|
||||||
/// Set a directory to create files in. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
/// | ||||||
/// This is an alternative API that achieves essentially the same thing as | ||||||
/// `tempfile_in` and `tempdir_in`. | ||||||
/// | ||||||
/// Default: `env::temp_dir()` | ||||||
/// | ||||||
/// # Examples | ||||||
/// ``` | ||||||
/// use tempfile::Builder; | ||||||
/// use tempfile::tempdir; | ||||||
/// | ||||||
/// let parent = tempdir()?; | ||||||
/// let tempfile_in_parent = Builder::new() | ||||||
/// .parent_dir(parent.path()) | ||||||
/// .tempfile()?; | ||||||
/// # Ok::<(), std::io::Error>(()) | ||||||
pub fn parent_dir<P: AsRef<Path> + ?Sized>(&mut self, dir: &'c P) -> &mut Self { | ||||||
self.dir = Some(dir.as_ref()); | ||||||
self | ||||||
} | ||||||
|
||||||
/// Set the number of random bytes. | ||||||
/// | ||||||
/// Default: `6`. | ||||||
|
@@ -461,7 +485,7 @@ impl<'a, 'b> Builder<'a, 'b> { | |||||
/// [security]: struct.NamedTempFile.html#security | ||||||
/// [resource-leaking]: struct.NamedTempFile.html#resource-leaking | ||||||
pub fn tempfile(&self) -> io::Result<NamedTempFile> { | ||||||
self.tempfile_in(env::temp_dir()) | ||||||
self.tempfile_in(self.dir.unwrap_or(&env::temp_dir())) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Needs a documentation update here and below. |
||||||
} | ||||||
|
||||||
/// Create the named temporary file in the specified directory. | ||||||
|
@@ -530,7 +554,7 @@ impl<'a, 'b> Builder<'a, 'b> { | |||||
/// | ||||||
/// [resource-leaking]: struct.TempDir.html#resource-leaking | ||||||
pub fn tempdir(&self) -> io::Result<TempDir> { | ||||||
self.tempdir_in(env::temp_dir()) | ||||||
self.tempdir_in(self.dir.unwrap_or(&env::temp_dir())) | ||||||
} | ||||||
|
||||||
/// Attempts to make a temporary directory inside of `dir`. | ||||||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a breaking change. IMO, I messed up and should have had just one lifetime here (relying on sub-typing) but fixing that would also be a breaking change.
We can do one of:
AsRef
).I'd go with the former approach (probably using the prefix's lifetime,
'a
. It's a bit awkward but it provides the best upgrade path for an eventual v4.