Skip to content

Commit

Permalink
doc: clarify "inner file will be deleted" documentation (#329)
Browse files Browse the repository at this point in the history
fixes #203
  • Loading branch information
Stebalien authored Feb 16, 2025
1 parent 0fe11c4 commit 78d30a2
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/file/mod.rs
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

0 comments on commit 78d30a2

Please sign in to comment.