Struct VZMacOSInstaller

Source

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

Available on crate feature VZMacOSInstaller only.

Expand description

VZMacOSInstaller is used to install macOS on the specified virtual machine.

A VZMacOSInstaller object must be initialized with a VZVirtualMachine and a file URL referring to a macOS restore image. The following code example shows how VZMacOSInstaller is used.


```text

    // VZMacOSInstaller must be called with a URL corresponding to a local file. We need a place to store the restore image we download.
    NSURL *localRestoreImageURL = ...;

    // Load the latest restore image.
    [VZMacOSRestoreImage fetchLatestSupportedWithCompletionHandler:^(VZMacOSRestoreImage *restoreImage, NSError *error) {
        if (error) {
            // Handle the error.
            abort();
        }

        // VZMacOSInstaller must be called with a URL corresponding to a local file. Since restoreImage came from
        // fetchLatestSupportedWithCompletionHandler, its URL property refers to a restore image on the network.
        // Download the restore image to the local filesystem.
        [[NSURLSession sharedSession] downloadTaskWithURL:restoreImage.URL completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
            if (error) {
                // Handle the error.
                abort();
            }
            if (![[NSFileManager defaultManager] moveItemAtURL:location toURL:localRestoreImageURL error:&error]) {
                // Handle the error.
                abort();
            }
            dispatch_async(dispatch_get_main_queue(), ^{
                // Since this restore image came from -[VZMacOSRestoreImage fetchLatestSupportedWithCompletionHandler:], mostFeaturefulSupportedConfiguration should not be nil.
                VZMacOSConfigurationRequirements *configurationRequirements = restoreImage.mostFeaturefulSupportedConfiguration;

                // Construct a VZVirtualMachineConfiguration that satisfies the configuration requirements.
                VZVirtualMachineConfiguration *configuration = [[VZVirtualMachineConfiguration alloc] init];
                configuration.bootLoader = [[VZMacOSBootLoader alloc] init];
                configuration.platform = [[VZMacPlatformConfiguration alloc] init];

                // The following are minimum values; you can use larger values if desired.
                configuration.CPUCount = configurationRequirements.minimumSupportedCPUCount;
                configuration.memorySize = configurationRequirements.minimumSupportedMemorySize;

                // Set other configuration properties as necessary.
                // ...

                assert([configuration validateWithError:nil]);

                VZVirtualMachine *virtualMachine = [[VZVirtualMachine alloc] initWithConfiguration:configuration];
                VZMacOSInstaller *installer = [[VZMacOSInstaller alloc] initWithVirtualMachine:virtualMachine restoreImageURL:localRestoreImageURL];
                [installer installWithCompletionHandler:^(NSError *error) {
                    if (error) {
                        // Handle the error.
                        abort();
                    } else {
                        // Installation was successful.
                    }
                }];

                // Observe progress using installer.progress object.
            });
        }];
    }];

```

Implementations§

Source §

pub unsafe fn initWithVirtualMachine_restoreImageURL( this: Allocated<Self>, virtual_machine: &VZVirtualMachine, restore_image_file_url: &NSURL, ) -> Retained<Self>

Available on crate feature VZVirtualMachine only.

Initialize a VZMacOSInstaller object.

Parameter virtualMachine: The virtual machine that the operating system will be installed onto.

Parameter restoreImageFileURL: A file URL indicating the macOS restore image to install.

The virtual machine platform must be macOS and the restore image URL must be a file URL referring to a file on disk or an exception will be raised. This method must be called on the virtual machine’s queue.

Source

pub unsafe fn installWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate feature block2 only.

Start installing macOS.

Parameter completionHandler: Block called after installation has successfully completed or has failed. The error parameter passed to the block is nil if installation was successful. The block will be invoked on the virtual machine’s queue.

This method starts the installation process. The virtual machine must be in a stopped state. During the installation operation, pausing or stopping the virtual machine will result in undefined behavior. If installation is started on the same VZMacOSInstaller object more than once, an exception will be raised. This method must be called on the virtual machine’s queue.

Source

pub unsafe fn progress(&self) -> Retained<NSProgress>

An NSProgress object that can be used to observe or cancel installation.

If the progress object is cancelled before installation is started, an exception will be raised.

Source

pub unsafe fn virtualMachine(&self) -> Retained<VZVirtualMachine>

Available on crate feature VZVirtualMachine only.

The virtual machine that this installer was initialized with.

Source

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

The restore image URL that this installer was initialized with.

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`
    }
}