Struct BandwidthGroup 

pub struct BandwidthGroup { /* private fields */ }

Represents one bandwidth group.

Reference to the official documentation:

https://www.virtualbox.org/sdkref/interface_i_bandwidth_group.html

Implementations

impl BandwidthGroup

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

Name of the group.

Returns

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

Example

use virtualbox_rs::{VirtualBox};

let vbox = VirtualBox::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
let bandwidth_control = machine.get_bandwidth_control().unwrap();
let bandwidth_group = bandwidth_control.get_bandwidth_group("g1").unwrap();
let name = bandwidth_group.get_name().unwrap();

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

Type of the group.

Returns

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

Example

use virtualbox_rs::{VirtualBox};

let vbox = VirtualBox::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
let bandwidth_control = machine.get_bandwidth_control().unwrap();
let bandwidth_group = bandwidth_control.get_bandwidth_group("g1").unwrap();
let group_type = bandwidth_group.get_type().unwrap();

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

How many devices/medium attachments use this group.

Returns

Returns u32 on success, or a VboxError on failure.

Example

use virtualbox_rs::{VirtualBox};

let vbox = VirtualBox::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
let bandwidth_control = machine.get_bandwidth_control().unwrap();
let bandwidth_group = bandwidth_control.get_bandwidth_group("g1").unwrap();
let reference = bandwidth_group.get_reference().unwrap();

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

The maximum number of bytes which can be transfered by all entities attached to this group during one second.

Returns

Returns u32 on success, or a VboxError on failure.

Example

use virtualbox_rs::{VirtualBox};

let vbox = VirtualBox::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
let bandwidth_control = machine.get_bandwidth_control().unwrap();
let bandwidth_group = bandwidth_control.get_bandwidth_group("g1").unwrap();
let max_bytes_per_sec = bandwidth_group.get_max_bytes_per_sec().unwrap();

pub fn set_max_bytes_per_sec( &self, max_bytes_per_sec: i64, ) -> Result<(), VboxError>

The maximum number of bytes which can be transfered by all entities attached to this group during one second.

Arguments

• max_bytes_per_sec - u32.

Returns

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

Example

use virtualbox_rs::{VirtualBox};

let vbox = VirtualBox::init().unwrap();
let machine = vbox.
        find_machines("Freebsd_14").unwrap();
let bandwidth_control = machine.get_bandwidth_control().unwrap();
let bandwidth_group = bandwidth_control.get_bandwidth_group("g1").unwrap();
bandwidth_group.set_max_bytes_per_sec(100000).unwrap();

Trait Implementations

impl Debug for BandwidthGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for BandwidthGroup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for BandwidthGroup

fn drop(&mut self)

Executes the destructor for this type.