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

use crate::session::Session;
use crate::utility::macros::macros::get_function_result_pointer;
use crate::virtualbox::VirtualBox;
use crate::virtualbox_client::VirtualBoxClient;
use crate::VboxError;
use vbox_raw::sys_lib::{ISession, IVirtualBox};

impl VirtualBoxClient {
    /// Reference to the server-side API root object.
    ///
    ///
    /// # Returns
    ///
    /// Returns [`VirtualBox`] on success, or a [`VboxError`] on failure.
    ///
    ///  # Example
    ///
    /// ```no_run
    ///
    /// use virtualbox_rs::{VirtualBox, VirtualBoxClient};
    ///
    /// let vbox_client = VirtualBoxClient::init().unwrap();
    ///
    /// let vbox = vbox_client.get_virtualbox().unwrap();
    ///
    pub fn get_virtualbox(&self) -> Result<VirtualBox, VboxError> {
        let vbox = get_function_result_pointer!(self.object, GetVirtualBox, *mut IVirtualBox)?;
        Ok(VirtualBox::new(vbox))
    }

    /// Create a new session object and return it.
    ///
    ///
    /// # Returns
    ///
    /// Returns [`Session`] on success, or a [`VboxError`] on failure.
    ///
    ///  # Example
    ///
    /// ```no_run
    ///
    /// use virtualbox_rs::{VirtualBox, VirtualBoxClient};
    ///
    /// let vbox_client = VirtualBoxClient::init().unwrap();
    ///
    /// let session = vbox_client.get_session().unwrap();
    ///
    pub fn get_session(&self) -> Result<Session, VboxError> {
        let session = get_function_result_pointer!(self.object, GetSession, *mut ISession)?;
        Ok(Session::new(session))
    }
}