summaryrefslogtreecommitdiff
path: root/src/cmd/list.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/list.rs')
-rw-r--r--src/cmd/list.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/cmd/list.rs b/src/cmd/list.rs
index a67dfb7..c83be26 100644
--- a/src/cmd/list.rs
+++ b/src/cmd/list.rs
@@ -1,13 +1,21 @@
+//! The `list` sub-command.
+
use crate::config::Configuration;
use virt::connect::Connect;
+/// Errors returned from this module.
#[derive(Debug, thiserror::Error)]
pub enum ListError {
+ /// An error from libvirt.
#[error(transparent)]
VirtError(#[from] virt::error::Error),
}
+/// The `list` sub-command.
+///
+/// Return all the virtual machines existing on the libvirt instance,
+/// and their current state.
pub fn list(_config: &Configuration) -> Result<(), ListError> {
let conn = Connect::open("qemu:///system")?;
let domains = conn.list_all_domains(0)?;