virtualbox_rs 0.4.2

A Rust library for interacting with VirtualBox, providing a safe and idiomatic interface to the VirtualBox API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

pub mod implementation;

use crate::utility::macros::macros::call_function;
use crate::VboxError;
use log::{debug, error};
use std::collections::BTreeMap;
use std::fmt::{Debug, Display, Formatter};
use vbox_raw::sys_lib::IProgress;

/// The Progress interface is used to track and control asynchronous tasks within VirtualBox.
///
/// **Reference to the official documentation:**
///
/// [https://www.virtualbox.org/sdkref/interface_i_progress.html](https://www.virtualbox.org/sdkref/interface_i_progress.html)
///
///
/// **Note:**
///
/// The [`Progress`] fields are typically filled during the [`Progress::wait_for_completion`] or
/// [`Progress::wait_for_operation_completion`] calls. If you check [`Progress::get_completed`] without prior
/// waiting via these methods, it will always return false, even after the operation
/// has completed.
///
pub struct Progress {
    object: *mut IProgress,
}

impl Progress {
    pub(crate) fn new(object: *mut IProgress) -> Self {
        Self { object }
    }

    fn release(&self) -> Result<i32, VboxError> {
        call_function!(self.object, Release)
    }
}

impl Drop for Progress {
    fn drop(&mut self) {
        match self.release() {
            Ok(count) => {
                debug!("Progress refcount: {}", count)
            }
            Err(err) => {
                error!("Failed drop Progress Error: {:?}", err)
            }
        }
    }
}

unsafe impl Send for Progress {}

impl Display for Progress {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut map = BTreeMap::new();
        map.insert("completed", self.get_completed().unwrap_or(false).to_string());
        map.insert("id", self.get_id().unwrap_or("").to_string());
        map.insert(
            "description",
            self.get_description().unwrap_or("").to_string(),
        );
        map.insert(
            "cancelable",
            self.get_cancelable().unwrap_or(false).to_string(),
        );
        map.insert("percent", self.get_percent().unwrap_or(0).to_string());
        map.insert(
            "result_code",
            self.get_result_code().unwrap_or(0).to_string(),
        );
        map.insert(
            "operation_count",
            self.get_operation_count().unwrap_or(0).to_string(),
        );
        map.insert("operation", self.get_operation().unwrap_or(0).to_string());
        map.insert(
            "operation_description",
            self.get_operation_description().unwrap_or("").to_string(),
        );
        map.insert(
            "operation_percent",
            self.get_operation_percent().unwrap_or(0).to_string(),
        );
        map.insert(
            "operation_weight",
            self.get_operation_weight().unwrap_or(0).to_string(),
        );
        map.insert("timeout", self.get_timeout().unwrap_or(0).to_string());
        match self.get_error_info() {
            Ok(error_info) => {
                if f.alternate() {
                    map.insert("error_info", format!("{:#?}", error_info));
                }else {
                    map.insert("error_info", format!("{:?}", error_info));
                }
            }
            Err(_) => {}
        }

        if f.alternate() {
            write!(f, "{}", format!("{:#?}", map))
        } else {
            write!(f, "{}", format!("{:?}", map))
        }
    }
}

impl Debug for Progress {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        Display::fmt(self, f)
    }
}