Struct OSSystemExtensionRequest

Source

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

Expand description

Apple’s documentation

Implementations§

Source §

impl OSSystemExtensionRequest

Source

pub unsafe fn activationRequestForExtension_queue( identifier: &NSString, queue: &DispatchQueue, ) -> Retained<Self>

Available on crate feature dispatch2 only.

Creates a request to activate a System Extension.

This method creates a new request to activate a System Extension. Extensions are bundles discovered from the Contents/Library/SystemExtensions directory of the main application bundle.

Parameter identifier: The bundle identifier of the target extension.

Parameter queue: The dispatch queue to use when calling delegate methods.

Returns: A new extension request.

Note: It is expected that an application create and submit an activation request whenever an extension should be active. Upon submitting an activation request for an inactive extension, user approval may be required and the request will not succeed until approval is given.

If the extension is already active then the request will succeed in short order without significant delay or user interaction. Activating an new version of an already active extension will prompt the delegate to resolve the conflict before proceeding.

An activation request can be successful but also indicate that a reboot is required in order for the extension to become active. This can occur when replacing an existing extension that required a reboot in order to deactivate. The most recently activated extension will then become active when the system is next rebooted.

Source

pub unsafe fn deactivationRequestForExtension_queue( identifier: &NSString, queue: &DispatchQueue, ) -> Retained<Self>

Available on crate feature dispatch2 only.

Creates a request to deactivate a System Extension.

This method creates a new request to deactivate a System Extension. Extensions are discovered from the Contents/Library/SystemExtensions directory of the main application bundle.

Parameter identifier: The bundle identifier of the target extension.

Parameter queue: The dispatch queue to use when calling delegate methods.

Note: It is possible for an extension to require a reboot before it is fully deactivated. If a request succeeds and indicates a reboot is required, the extension may still appear to be operational until that time.

Source

pub unsafe fn propertiesRequestForExtension_queue( identifier: &NSString, queue: &DispatchQueue, ) -> Retained<Self>

Available on crate feature dispatch2 only.

Creates a request to get information about System Extensions.

This method creates a new request to retrieve the properties of any System Extensions matching the given identifier.

Parameter identifier: The bundle identifier of the target extension(s).

Parameter queue: The dispatch queue to use when calling delegate methods.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn OSSystemExtensionRequestDelegate>>>

A delegate to receive updates about the progress of a request

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn OSSystemExtensionRequestDelegate>>, )

This is a weak property. Setter for delegate.

Source

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

The bundle identifier of the target extension

Source §

impl OSSystemExtensionRequest

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

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