pub struct MediumFormat { /* private fields */ }Expand description
The IMediumFormat interface represents a medium format.
Reference to the official documentation:
https://www.virtualbox.org/sdkref/interface_i_medium_format.html
Implementations§
Source§impl MediumFormat
impl MediumFormat
Sourcepub fn get_id(&self) -> Result<&'static str, VboxError>
pub fn get_id(&self) -> Result<&'static str, VboxError>
Identifier of this format.
The format identifier is a non-null non-empty ASCII string. Note that this string is case-insensitive.
This string is used in methods of other interfaces where it is necessary to specify a medium format, such as VirtualBox::create_medium.
§Returns
Returns &str on success, or a VboxError on failure.
§Example
use virtualbox_rs::VirtualBox;
let vbox = VirtualBox::init().unwrap();
let mediums = vbox.get_hard_disks().unwrap();
let medium = mediums.get(0).unwrap();
let medium_format = medium.get_medium_format().unwrap();
let id = medium_format.get_id().unwrap();Sourcepub fn get_name(&self) -> Result<&'static str, VboxError>
pub fn get_name(&self) -> Result<&'static str, VboxError>
Human-readable description of this format.
Mainly for use in file open dialogs.
§Returns
Returns &str on success, or a VboxError on failure.
§Example
use virtualbox_rs::VirtualBox;
let vbox = VirtualBox::init().unwrap();
let mediums = vbox.get_hard_disks().unwrap();
let medium = mediums.get(0).unwrap();
let medium_format = medium.get_medium_format().unwrap();
let id = medium_format.get_id().unwrap();Sourcepub fn get_capabilities(
&self,
) -> Result<Vec<MediumFormatCapabilities>, VboxError>
pub fn get_capabilities( &self, ) -> Result<Vec<MediumFormatCapabilities>, VboxError>
Capabilities of the format as an array of the flags.
For the meaning of individual capability flags see MediumFormatCapabilities.
§Returns
Returns Vec<MediumFormatCapabilities> on success, or a VboxError on failure.
§Example
use virtualbox_rs::VirtualBox;
let vbox = VirtualBox::init().unwrap();
let mediums = vbox.get_hard_disks().unwrap();
let medium = mediums.get(0).unwrap();
let medium_format = medium.get_medium_format().unwrap();
let capabilities = medium_format.get_capabilities().unwrap();Sourcepub fn describe_file_extensions(
&self,
) -> Result<Vec<(&'static str, DeviceType)>, VboxError>
pub fn describe_file_extensions( &self, ) -> Result<Vec<(&'static str, DeviceType)>, VboxError>
returns the list of supported file extensions and device types.
§Returns
Returns Vec<(extension, device_type) on success, or a VboxError on failure.
extension- supported extensions.device_type- device type for extension.
§Example
use virtualbox_rs::VirtualBox;
let vbox = VirtualBox::init().unwrap();
let mediums = vbox.get_hard_disks().unwrap();
let medium = mediums.get(0).unwrap();
let medium_format = medium.get_medium_format().unwrap();
let file_extensions = medium_format.describe_file_extensions().unwrap();Sourcepub fn describe_properties(
&self,
) -> Result<Vec<(&'static str, &'static str, DeviceType, MediumFormatCapabilities, &'static str)>, VboxError>
pub fn describe_properties( &self, ) -> Result<Vec<(&'static str, &'static str, DeviceType, MediumFormatCapabilities, &'static str)>, VboxError>
Returns array describing the properties supported by this format.
§Returns
Returns Vec<(names, descriptions, device_type, flags, defaults) on success, or a VboxError on failure.
names- supported extensions.descriptions- device type for extension.device_type- device type for extension.flags- device type for extension.defaults- device type for extension.
§Example
use virtualbox_rs::VirtualBox;
let vbox = VirtualBox::init().unwrap();
let mediums = vbox.get_hard_disks().unwrap();
let medium = mediums.get(0).unwrap();
let medium_format = medium.get_medium_format().unwrap();
let describe_properties = medium_format.describe_properties().unwrap();