Skip to content

Commit

Permalink
Merge pull request #1912 from wowinter13/improve-drop-docs
Browse files Browse the repository at this point in the history
Add more examples @ drop.md
  • Loading branch information
marioidival authored Feb 6, 2025
2 parents a349a04 + 1fe268a commit 66543bb
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions src/trait/drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,56 @@ fn main() {
}
```

For a more practical example, here's how the `Drop` trait can be used to automatically
clean up temporary files when they're no longer needed:

```rust,editable
use std::fs::File;
use std::path::PathBuf;
struct TempFile {
file: File,
path: PathBuf,
}
impl TempFile {
fn new(path: PathBuf) -> std::io::Result<Self> {
// Note: File::create() will overwrite existing files
let file = File::create(&path)?;
Ok(Self { file, path })
}
}
// When TempFile is dropped:
// 1. First, the File will be automatically closed (Drop for File)
// 2. Then our drop implementation will remove the file
impl Drop for TempFile {
fn drop(&mut self) {
// Note: File is already closed at this point
if let Err(e) = std::fs::remove_file(&self.path) {
eprintln!("Failed to remove temporary file: {}", e);
}
println!("> Dropped temporary file: {:?}", self.path);
}
}
fn main() -> std::io::Result<()> {
// Create a new scope to demonstrate drop behavior
{
let temp = TempFile::new("test.txt".into())?;
println!("Temporary file created");
// File will be automatically cleaned up when temp goes out of scope
}
println!("End of scope - file should be cleaned up");
// We can also manually drop if needed
let temp2 = TempFile::new("another_test.txt".into())?;
drop(temp2); // Explicitly drop the file
println!("Manually dropped file");
Ok(())
}
```

[Drop]: https://doc.rust-lang.org/std/ops/trait.Drop.html

0 comments on commit 66543bb

Please sign in to comment.