Add option to purge BuildDirectory on drop

Author: jyn514

src/build.rs

@@ -21,6 +21,7 @@ pub(crate) struct CratePatch {
 pub struct BuildDirectory {
     workspace: Workspace,
     name: String,
+    purge_on_drop: bool,
 }
 
 /// Builder for configuring builds in a [`BuildDirectory`](struct.BuildDirectory.html).
@@ -97,6 +98,7 @@ impl BuildDirectory {
         Self {
             workspace,
             name: name.into(),
+            purge_on_drop: false,
         }
     }
 
@@ -172,6 +174,13 @@ impl BuildDirectory {
         Ok(())
     }
 
+    /// Enable or disable purging the build directory when dropped.
+    ///
+    /// By default, the directory is not dropped.
+    pub fn purge_on_drop(&mut self, yes: bool) {
+        self.purge_on_drop = yes;
+    }
+
     fn build_dir(&self) -> PathBuf {
         self.workspace.builds_dir().join(&self.name)
     }
@@ -185,6 +194,16 @@ impl BuildDirectory {
     }
 }
 
+impl Drop for BuildDirectory {
+    fn drop(&mut self) {
+        if self.purge_on_drop {
+            if let Err(err) = self.purge() {
+                log::error!("failed to delete build directory: {}", err);
+            }
+        }
+    }
+}
+
 /// API to interact with a running build.
 ///
 /// This is created from [`BuildDirectory::build`](struct.BuildDirectory.html#method.build)