Struct HMAccessoryBrowser

Source

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

Available on crate feature HMAccessoryBrowser only.

Expand description

This class is used to discover new accessories in the home that have never been paired with and therefore not part of the home.

Implementations§

Source §

impl HMAccessoryBrowser

Source

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

Source

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

Delegate that receives updates on the state of the accessories discovered.

Source

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

This is a weak property. Setter for delegate.

Source

pub unsafe fn discoveredAccessories(&self) -> Retained<NSArray<HMAccessory>>

Available on crate feature HMAccessory only.

This is the array of HMAccessory objects that represents new accessories that were discovered as part of a search session. This array is not updated when a search session is not in progress.

Source

pub unsafe fn startSearchingForNewAccessories(&self)

Starts searching for accessories that are not associated to any home.

If any accessories are discovered, updates are sent to the delegate. This will scan for the following types of accessories: Accessories supporting HomeKit Wireless Accessory Configuration profile Accessories supporting HomeKit Accessory Protocol and are already on the same infrastructure IP network Accessories supporting HomeKit Accessory Protocol on Bluetooth LE transport The array of discovered accessories will be updated when this method is called, so applications should clear and reload any stored copies of that array or previous new accessory objects.

Source

pub unsafe fn stopSearchingForNewAccessories(&self)

Stops searching for new accessories.

After this method is called, updates will not be sent to the delegate if new accessories are found or removed. Scanning may continue for system reasons or if other delegates are still in active searching sessions. The contents of the array of discovered accessories will not be updated until startSearchingForNewAccessories is called.

Source §

impl HMAccessoryBrowser

Methods declared on superclass NSObject.

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.

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