Struct ICDeviceBrowser 

pub struct ICDeviceBrowser { /* private fields */ }

Available on crate feature ICDeviceBrowser only.

The ICDeviceBrowser object is used to find devices such as digital cameras and scanners that are supported by Image Capture. These device may be directly attached to the USB or FireWire bus on the host computer, or available over a TCP/IP network. This object communicates with an Image Capture agent process asynchronously to accomplish this.

See also Apple’s documentation

Implementations

impl ICDeviceBrowser

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

The delegate. It must conform to ICDeviceBrowserDelegate protocol. The messages this delegate can expect to receive are described by ICDeviceBrowserDelegate protocol.

Safety

This is not retained internally, you must ensure the object is still alive.

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

Setter for delegate.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn isBrowsing(&self) -> bool

Indicates whether the device browser is browsing for devices.

pub unsafe fn isSuspended(&self) -> bool

Indicates whether the devices in the browser have suspended communication.

pub unsafe fn browsedDeviceTypeMask(&self) -> ICDeviceTypeMask

Available on crate feature ICDevice only.

A mask whose set bits indicate the type of device(s) being browsed after the receiver receives the start message. This property can be changed while the browser is browsing for devices. This property can be constructed by OR’d values of ICDeviceTypeMask with values of ICDeviceLocationTypeMask.

pub unsafe fn setBrowsedDeviceTypeMask( &self, browsed_device_type_mask: ICDeviceTypeMask, )

Available on crate feature ICDevice only.

Setter for browsedDeviceTypeMask.

pub unsafe fn devices(&self) -> Option<Retained<NSArray<ICDevice>>>

Available on crate feature ICDevice only.

All devices found by the browser. This property will change as devices appear and disappear. This array is empty before the first invocation of the delegate method ‘deviceBrowser:didAddDevice:moreComing:’.

pub unsafe fn preferredDevice(&self) -> Option<Retained<ICDevice>>

Available on crate feature ICDevice only.

This property returns a device object that should be selected by the client application when it is launched.

If the client application that calls this method is the auto-launch application associated with a device and that device is the last device attached (through USB, FireWire or network), then that device will be the preferred device. The best place to call this method is in the implmentation of the ICDeviceBrowser delegate method “deviceBrowser:didAddDevice:moreComing:”, if the “moreComing” parameter passed to the delegate is “NO”; or in the delegate method “deviceBrowserDidEnumerateLocalDevices:”.

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

This is the designated initializer.

pub unsafe fn start(&self)

This message tells the receiver to start looking for devices.

Make sure that the receiver’s delegate is set prior to sending this message; otherwise this message will be ignored. The messages the delegate can expect to receive are described by ICDeviceBrowserDelegate protocol.

pub unsafe fn stop(&self)

This method tells the receiver to stop looking for devices.

This will free all device instances that are not in use.

pub unsafe fn contentsAuthorizationStatus( &self, ) -> Retained<ICAuthorizationStatus>

This property returns a constant indicating whether the app has permission to acces the contents of an attached media device.

A constant indicating authorization status.

pub unsafe fn requestContentsAuthorizationWithCompletion( &self, completion: &DynBlock<dyn Fn(NonNull<ICAuthorizationStatus>)>, )

Available on crate feature block2 only.

This method requests the user’s permission, if needed, for accessing the conents of an external media device.

pub unsafe fn controlAuthorizationStatus( &self, ) -> Retained<ICAuthorizationStatus>

This property returns a constant indicating whether the app has permission to control the attached camera device.

pub unsafe fn requestControlAuthorizationWithCompletion( &self, completion: &DynBlock<dyn Fn(NonNull<ICAuthorizationStatus>)>, )

Available on crate feature block2 only.

This method requests the user’s permission, if needed, for controlling the attached camera device.

pub unsafe fn resetContentsAuthorizationWithCompletion( &self, completion: &DynBlock<dyn Fn(NonNull<ICAuthorizationStatus>)>, )

Available on crate feature block2 only.

This method resets the authorization status for the application accessing the conents of an external media device.

pub unsafe fn resetControlAuthorizationWithCompletion( &self, completion: &DynBlock<dyn Fn(NonNull<ICAuthorizationStatus>)>, )

Available on crate feature block2 only.

This method resets the authorization status for the application controlling the attached camera device.

If the application already has been granted camera access, this will reset only the presentation dialog letting the user know the app has permission, not the camera access itself.

impl ICDeviceBrowser

Methods declared on superclass NSObject.

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

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

impl AsRef<AnyObject> for ICDeviceBrowser

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ICDeviceBrowser> for ICDeviceBrowser

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for ICDeviceBrowser

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for ICDeviceBrowser

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ICDeviceBrowser

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ICDeviceBrowser

const NAME: &'static str = "ICDeviceBrowser"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ICDeviceBrowser as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for ICDeviceBrowser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ICDeviceBrowser

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for ICDeviceBrowser

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for ICDeviceBrowser

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ICDeviceBrowser

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for ICDeviceBrowser

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for ICDeviceBrowser

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for ICDeviceBrowser

impl Eq for ICDeviceBrowser