Struct Progress

Source

pub struct Progress { /* private fields */ }

Expand description

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

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.

Implementations§

Source §

impl Progress

Source

pub fn wait_for_completion(&self, timeout: i32) -> Result<(), VboxError>

Waits until the task is done (including all sub-operations) with a given timeout in milliseconds; specify -1 for an indefinite wait.

§Arguments

timeout - Maximum time in milliseconds to wait or -1 to wait indefinitely.

§Returns

Returns Ok(()) on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();

Source

pub fn get_id(&self) -> Result<&'static str, VboxError>

ID of the task.

§Returns

Returns &str on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let id = progress.get_id().unwrap();

Source

pub fn get_description(&self) -> Result<&'static str, VboxError>

Description of the task.

§Returns

Returns &str on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let description = progress.get_description().unwrap();

Source

pub fn get_cancelable(&self) -> Result<bool, VboxError>

Whether the task can be interrupted.

§Returns

Returns bool on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let cancelable = progress.get_cancelable().unwrap();

Source

pub fn get_percent(&self) -> Result<u32, VboxError>

Current progress value of the task as a whole, in percent.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let percent = progress.get_percent().unwrap();

Source

pub fn get_time_remaining(&self) -> Result<i32, VboxError>

Estimated remaining time until the task completes, in seconds.

§Returns

Returns i32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let time_remaining = progress.get_time_remaining().unwrap();

Source

pub fn get_completed(&self) -> Result<bool, VboxError>

Whether the task has been completed.

§Returns

Returns bool on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let completed = progress.get_completed().unwrap();

Source

pub fn get_canceled(&self) -> Result<bool, VboxError>

Whether the task has been canceled.

§Returns

Returns bool on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(1).unwrap();
let canceled = progress.get_canceled().unwrap();

Source

pub fn get_result_code(&self) -> Result<i32, VboxError>

Result code of the progress task.

§Returns

Returns i32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let result_code = progress.get_result_code().unwrap();

Source

pub fn get_error_info(&self) -> Result<VirtualBoxErrorInfo, VboxError>

Extended information about the unsuccessful result of the progress operation.

§Returns

Returns VirtualBoxErrorInfo on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let error_info = progress.get_error_info().unwrap();

Source

pub fn get_operation_count(&self) -> Result<u32, VboxError>

Number of sub-operations this task is divided into.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let operation_count = progress.get_operation_count().unwrap();

Source

pub fn get_operation(&self) -> Result<u32, VboxError>

Number of the sub-operation being currently executed.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let operation = progress.get_operation().unwrap();

Source

pub fn get_operation_description(&self) -> Result<&'static str, VboxError>

Description of the sub-operation being currently executed.

§Returns

Returns &str on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let operation_description = progress.get_operation_description().unwrap();

Source

pub fn get_operation_percent(&self) -> Result<u32, VboxError>

Progress value of the current sub-operation only, in percent.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let operation_percent = progress.get_operation_percent().unwrap();

Source

pub fn get_operation_weight(&self) -> Result<u32, VboxError>

Weight value of the current sub-operation only.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let operation_weight = progress.get_operation_weight().unwrap();

Source

pub fn get_timeout(&self) -> Result<u32, VboxError>

When non-zero, this specifies the number of milliseconds after which the operation will automatically be canceled.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let timeout = progress.get_timeout().unwrap();

Source

pub fn get_event_source(&self) -> Result<EventSource, VboxError>

EventSource

§Returns

Returns EventSource on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_completion(-1).unwrap();
let event_source = progress.get_event_source().unwrap();

Source

pub fn wait_for_operation_completion( &self, timeout: i32, operation: u32, ) -> Result<(), VboxError>

Waits until the given operation is done with a given timeout in milliseconds; specify -1 for an indefinite wait.

§Arguments

timeout - Maximum time in milliseconds to wait or -1 to wait indefinitely.
operation - Number of the operation to wait for. Must be less than operationCount.

§Returns

Returns () on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.wait_for_operation_completion(-1, 1).unwrap();

Source

pub fn cancel(&self) -> Result<(), VboxError>

Cancels the task.

§Returns

Returns u32 on success, or a VboxError on failure.

§Example


use virtualbox_rs::{Session, VirtualBox};
use virtualbox_rs::enums::SessionType;

let vbox = VirtualBox::init().unwrap();
let mut session = Session::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
machine.lock_machine(&mut session, SessionType::Shared).unwrap();

let machine_mut = session.get_machine().unwrap();

let progress = machine_mut.save_state().unwrap();
progress.cancel().unwrap();