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

use crate::enums::CPUArchitecture;
use crate::utility::macros::macros::{get_function_result_number, get_function_result_str};
use crate::{CPUProfile, VboxError};

impl CPUProfile {
    /// The name.
    ///
    /// # Returns
    ///
    /// Returns &str on success, or a [`VboxError`] on failure.
    ///
    ///  # Example
    ///
    /// ```no_run
    ///
    /// use virtualbox_rs::enums::CPUArchitecture;
    /// use virtualbox_rs::SystemProperties;
    ///
    /// let system_properties = SystemProperties::init().unwrap();
    ///
    /// let cpu_profiles = system_properties.get_cpu_profiles(CPUArchitecture::Any, "*").unwrap();
    /// let cpu_profile = cpu_profiles.get(0).unwrap();
    /// let name = cpu_profile.get_name().unwrap();
    pub fn get_name(&self) -> Result<&'static str, VboxError> {
        get_function_result_str!(self.object, GetName)
    }

    /// The full name.
    ///
    /// # Returns
    ///
    /// Returns &str on success, or a [`VboxError`] on failure.
    ///
    ///  # Example
    ///
    /// ```no_run
    ///
    /// use virtualbox_rs::enums::CPUArchitecture;
    /// use virtualbox_rs::SystemProperties;
    ///
    /// let system_properties = SystemProperties::init().unwrap();
    ///
    /// let cpu_profiles = system_properties.get_cpu_profiles(CPUArchitecture::Any, "*").unwrap();
    /// let cpu_profile = cpu_profiles.get(0).unwrap();
    /// let full_name = cpu_profile.get_full_name().unwrap();
    pub fn get_full_name(&self) -> Result<&'static str, VboxError> {
        get_function_result_str!(self.object, GetFullName)
    }

    /// The CPU architecture.
    ///
    /// # Returns
    ///
    /// Returns [`CPUArchitecture`] on success, or a [`VboxError`] on failure.
    ///
    ///  # Example
    ///
    /// ```no_run
    ///
    /// use virtualbox_rs::enums::CPUArchitecture;
    /// use virtualbox_rs::SystemProperties;
    ///
    /// let system_properties = SystemProperties::init().unwrap();
    ///
    /// let cpu_profiles = system_properties.get_cpu_profiles(CPUArchitecture::Any, "*").unwrap();
    /// let cpu_profile = cpu_profiles.get(0).unwrap();
    /// let architecture = cpu_profile.get_architecture().unwrap();
    pub fn get_architecture(&self) -> Result<CPUArchitecture, VboxError> {
        let architecture = get_function_result_number!(self.object, GetArchitecture, u32)?;
        Ok(CPUArchitecture::from(architecture))
    }
}