Skip to content
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.

Sign up for GitHub

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

doc: clarify "inner file will be deleted" documentation #329

Merged
merged 1 commit into from
Feb 16, 2025
Merged

doc: clarify "inner file will be deleted" documentation #329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/file/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,9 +823,11 @@ impl<F> NamedTempFile<F> {
&mut self.file
}

/// Convert the temporary file into a `std::fs::File`.
/// Turn this named temporary file into an "unnamed" temporary file as if you
/// had constructed it with [`tempfile()`].
///
/// The inner file will be deleted.
/// The underlying file will be removed from the filesystem but the returned [`File`]
/// can still be read/written.
pub fn into_file(self) -> F {
self.file
}
Expand All @@ -840,8 +842,8 @@ impl<F> NamedTempFile<F> {

/// Converts the named temporary file into its constituent parts.
///
/// Note: When the path is dropped, the file is deleted but the file handle
/// is still usable.
/// Note: When the path is dropped, the underlying file will be removed from the filesystem but
/// the returned [`File`] can still be read/written.
pub fn into_parts(self) -> (F, TempPath) {
(self.file, self.path)
}
Expand Down