summaryrefslogtreecommitdiff
path: root/src/cmd/delete.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/delete.rs')
-rw-r--r--src/cmd/delete.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/cmd/delete.rs b/src/cmd/delete.rs
index 3f60e27..a9a0660 100644
--- a/src/cmd/delete.rs
+++ b/src/cmd/delete.rs
@@ -1,18 +1,26 @@
+//! The `delete` sub-command.
+
use crate::spec::Specification;
use log::{debug, info};
use std::thread;
use std::time::Duration;
use virt::connect::Connect;
+/// Errors from this module.
#[derive(Debug, thiserror::Error)]
pub enum DeleteError {
+ /// Error creating virtual machine.
#[error(transparent)]
VirtError(#[from] virt::error::Error),
+ /// Error doing I/O.
#[error(transparent)]
IoError(#[from] std::io::Error),
}
+/// Delete VMs corresponding to specifications.
+///
+/// Delete the VM corresponding to each specification provided by the caller.
pub fn delete(specs: &[Specification]) -> Result<(), DeleteError> {
for spec in specs {
info!("deleting virtual machine {}", spec.name);