#[repr(C)]pub struct VZUSBController { /* private fields */ }
VZUSBController
only.Expand description
Class representing a USB controller in a virtual machine.
VZUSBController should not be instantiated directly. USB controllers are first configured on the VZVirtualMachineConfiguration through a subclass of VZUSBControllerConfiguration. When a VZVirtualMachine is created from the configuration, the USB controllers are available through the VZVirtualMachine.usbControllers property. The real type of VZUSBController corresponds to the type used by the configuration. For example, a VZXHCIControllerConfiguration leads to a device of type VZXHCIController.
See: VZUSBControllerConfiguration
See also Apple’s documentation
Implementations§
Source§impl VZUSBController
impl VZUSBController
pub unsafe fn new() -> Retained<Self>
pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>
Sourcepub unsafe fn attachDevice_completionHandler(
&self,
device: &ProtocolObject<dyn VZUSBDevice>,
completion_handler: &DynBlock<dyn Fn(*mut NSError)>,
)
Available on crate features VZUSBDevice
and block2
only.
pub unsafe fn attachDevice_completionHandler( &self, device: &ProtocolObject<dyn VZUSBDevice>, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )
VZUSBDevice
and block2
only.Attach a USB device.
If the device is successfully attached to the controller, it will appear in the usbDevices property,
its usbController property will be set to point to the USB controller that it is attached to
and completion handler will return nil.
If the device was previously attached to this or another USB controller, attach function will fail
with the VZErrorDeviceAlreadyAttached
. If the device cannot be initialized correctly, attach
function will fail with VZErrorDeviceInitializationFailure
.
This method must be called on the virtual machine’s queue.
Parameter device
: USB device to attach.
Parameter completionHandler
: Block called after the device has been attached or on error.
The error parameter passed to the block is nil if the attach was successful.
It will be also invoked on an virtual machine’s queue.
See: VZUSBDevice
Sourcepub unsafe fn detachDevice_completionHandler(
&self,
device: &ProtocolObject<dyn VZUSBDevice>,
completion_handler: &DynBlock<dyn Fn(*mut NSError)>,
)
Available on crate features VZUSBDevice
and block2
only.
pub unsafe fn detachDevice_completionHandler( &self, device: &ProtocolObject<dyn VZUSBDevice>, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )
VZUSBDevice
and block2
only.Detach a USB device.
If the device is successfully detached from the controller, it will disappear from the usbDevices property,
its usbController property will be set to nil and completion handler will return nil.
If the device wasn’t attached to the controller at the time of calling detach method, it will fail
with the VZErrorDeviceNotFound
error.
This method must be called on the virtual machine’s queue.
Parameter device
: USB device to detach.
Parameter completionHandler
: Block called after the device has been detached or on error.
The error parameter passed to the block is nil if the detach was successful.
It will be also invoked on an virtual machine’s queue.
See: VZUSBDevice
Sourcepub unsafe fn usbDevices(
&self,
) -> Retained<NSArray<ProtocolObject<dyn VZUSBDevice>>>
Available on crate feature VZUSBDevice
only.
pub unsafe fn usbDevices( &self, ) -> Retained<NSArray<ProtocolObject<dyn VZUSBDevice>>>
VZUSBDevice
only.Return a list of USB devices attached to controller.
If corresponding USB controller configuration included in VZVirtualMachineConfiguration contained any USB devices, those devices will appear here when virtual machine is started.
See: VZUSBDevice
See: VZUSBDeviceConfiguration
See: VZUSBControllerConfiguration
See: VZVirtualMachineConfiguration
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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`
}
}
Trait Implementations§
Source§impl AsRef<AnyObject> for VZUSBController
impl AsRef<AnyObject> for VZUSBController
Source§impl AsRef<NSObject> for VZUSBController
impl AsRef<NSObject> for VZUSBController
Source§impl AsRef<VZUSBController> for VZUSBController
impl AsRef<VZUSBController> for VZUSBController
Source§impl AsRef<VZUSBController> for VZXHCIController
Available on crate feature VZXHCIController
only.
impl AsRef<VZUSBController> for VZXHCIController
VZXHCIController
only.Source§fn as_ref(&self) -> &VZUSBController
fn as_ref(&self) -> &VZUSBController
Source§impl Borrow<AnyObject> for VZUSBController
impl Borrow<AnyObject> for VZUSBController
Source§impl Borrow<NSObject> for VZUSBController
impl Borrow<NSObject> for VZUSBController
Source§impl Borrow<VZUSBController> for VZXHCIController
Available on crate feature VZXHCIController
only.
impl Borrow<VZUSBController> for VZXHCIController
VZXHCIController
only.Source§fn borrow(&self) -> &VZUSBController
fn borrow(&self) -> &VZUSBController
Source§impl ClassType for VZUSBController
impl ClassType for VZUSBController
Source§const NAME: &'static str = "VZUSBController"
const NAME: &'static str = "VZUSBController"
Source§type ThreadKind = <<VZUSBController as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<VZUSBController as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for VZUSBController
impl Debug for VZUSBController
Source§impl Deref for VZUSBController
impl Deref for VZUSBController
Source§impl Hash for VZUSBController
impl Hash for VZUSBController
Source§impl Message for VZUSBController
impl Message for VZUSBController
Source§impl NSObjectProtocol for VZUSBController
impl NSObjectProtocol for VZUSBController
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref