Struct VZMacOSRestoreImage

Source

#[repr(C)]
pub struct VZMacOSRestoreImage { /* private fields */ }

Available on crate feature VZMacOSRestoreImage only.

Expand description

VZMacOSRestoreImage describes a version of macOS to be installed to a virtual machine.

A VZMacOSRestoreImage object can be created by loading an installation media file. A VZMacOSInstaller object must be initialized with this VZMacOSRestoreImage object in order to install the operating system onto a virtual machine.

Loading a restore image requires the app to have the “com.apple.security.virtualization” entitlement.

Implementations§

Source §

pub unsafe fn loadFileURL_completionHandler( file_url: &NSURL, completion_handler: &DynBlock<dyn Fn(mut VZMacOSRestoreImage, mut NSError)>, )

Available on crate feature block2 only.

Load a restore image from a file on the local file system.

Parameter fileURL: A file URL indicating the macOS restore image to load.

Parameter completionHandler: Block called after the restore image has successfully loaded or has failed to load. The error parameter passed to the block is nil if the restore image was loaded successfully. The completion handler will be invoked on an arbitrary thread.

VZMacOSRestoreImage can load IPSW installation media from a local file. If the fileURL parameter does not refer to a local file, an exception will be raised.

Source

pub unsafe fn fetchLatestSupportedWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(mut VZMacOSRestoreImage, mut NSError)>, )

Available on crate feature block2 only.

Fetch the latest restore image supported by this host from the network.

Parameter completionHandler: Block called after the restore image fetch has succeeded or failed. The error parameter passed to the block is nil if the restore image was fetched successfully. The completion handler will be invoked on an arbitrary thread.

A VZMacOSInstaller object must be constructed with a VZMacOSRestoreImage loaded from a file on the local filesystem. A VZMacOSRestoreImage fetched with the fetchLatestSupportedWithCompletionHandler method will have a URL property referring to a restore image on the network. To use such a restore image, the file referred to by the URL property should be downloaded locally (using NSURLSession or similar API). After the restore image has been downloaded, a VZMacOSInstaller can be initialized using a URL referring to the local file.

Source

pub unsafe fn isSupported(&self) -> bool

Whether this restore image is supported on the current host.

Source

pub unsafe fn URL(&self) -> Retained<NSURL>

The URL of this restore image.

If the restore image was loaded using +[VZMacOSRestoreImage loadFileURL:completionHandler:], the value of this property will be a file URL. If the restore image was fetched using +[VZMacOSRestoreImage fetchLatestSupportedWithCompletionHandler:], the value of this property will be a network URL referring to an installation media file.

Source

pub unsafe fn buildVersion(&self) -> Retained<NSString>

The build version this restore image contains.

Source

pub unsafe fn operatingSystemVersion(&self) -> NSOperatingSystemVersion

The operating system version this restore image contains.

Source

pub unsafe fn mostFeaturefulSupportedConfiguration( &self, ) -> Option<Retained<VZMacOSConfigurationRequirements>>

Available on crate feature VZMacOSConfigurationRequirements only.

The configuration requirements for the most featureful configuration supported by the current host and by this restore image.

A VZMacOSRestoreImage can contain installation media for multiple Mac hardware models (VZMacHardwareModel). Some of these hardware models may not be supported by the current host. The mostFeaturefulSupportedConfiguration property can be used to determine the hardware model and configuration requirements that will provide the most complete feature set on the current host. If none of the hardware models are supported on the current host, this property is nil.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}