Struct DDDevice 

pub struct DDDevice { /* private fields */ }

Available on crate feature DDDevice only.

DeviceDiscoveryExtension device.

See also Apple’s documentation

Implementations

impl DDDevice

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

pub unsafe fn initWithDisplayName_category_protocolType_identifier( this: Allocated<Self>, display_name: &NSString, category: DDDeviceCategory, protocol_type: &UTType, identifier: &NSString, ) -> Retained<Self>

Available on crate feature objc2-uniform-type-identifiers only.

Initializes a DD device with display name, category, protocol type, and identifier.

pub unsafe fn deviceSupports(&self) -> DDDeviceSupports

Device supported capabilities.

pub unsafe fn setDeviceSupports(&self, device_supports: DDDeviceSupports)

Setter for deviceSupports.

pub unsafe fn bluetoothIdentifier(&self) -> Option<Retained<NSUUID>>

Identifier to communicate with the device via Bluetooth.

pub unsafe fn setBluetoothIdentifier( &self, bluetooth_identifier: Option<&NSUUID>, )

Setter for bluetoothIdentifier.

pub unsafe fn category(&self) -> DDDeviceCategory

Category of the device.

pub unsafe fn setCategory(&self, category: DDDeviceCategory)

Setter for category.

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

Device’s custom asset for product image name in the main App bundle.

pub unsafe fn setDisplayImageName(&self, display_image_name: Option<&NSString>)

Setter for displayImageName.

This is copied when set.

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

Name of the device. Should be suitable for displaying to a user.

pub unsafe fn setDisplayName(&self, display_name: &NSString)

Setter for displayName.

This is copied when set.

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

Identifier of the device.

pub unsafe fn setIdentifier(&self, identifier: &NSString)

Setter for identifier.

This is copied when set.

pub unsafe fn mediaPlaybackState(&self) -> DDDeviceMediaPlaybackState

Current state of media playback on this device.

pub unsafe fn setMediaPlaybackState( &self, media_playback_state: DDDeviceMediaPlaybackState, )

Setter for mediaPlaybackState.

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

Title of the media content being played.

pub unsafe fn setMediaContentTitle( &self, media_content_title: Option<&NSString>, )

Setter for mediaContentTitle.

This is copied when set.

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

Subtitle of the media content being played. It can be used to display extra information about the content, such as the name of the artist.

pub unsafe fn setMediaContentSubtitle( &self, media_content_subtitle: Option<&NSString>, )

Setter for mediaContentSubtitle.

This is copied when set.

pub unsafe fn protocol(&self) -> DDDeviceProtocol

Protocol of the device.

pub unsafe fn setProtocol(&self, protocol: DDDeviceProtocol)

Setter for protocol.

pub unsafe fn protocolType(&self) -> Retained<UTType>

Available on crate feature objc2-uniform-type-identifiers only.

Uniform Type for the protocol.

pub unsafe fn setProtocolType(&self, protocol_type: &UTType)

Available on crate feature objc2-uniform-type-identifiers only.

Setter for protocolType.

pub unsafe fn state(&self) -> DDDeviceState

State of the device.

pub unsafe fn setState(&self, state: DDDeviceState)

Setter for state.

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

Device’s WiFi Hotspot SSID.

pub unsafe fn setSSID(&self, ssid: Option<&NSString>)

Setter for SSID.

This is copied when set.

pub unsafe fn supportsGrouping(&self) -> bool

Whether the device supports grouping with other devices with the same protocol.

pub unsafe fn setSupportsGrouping(&self, supports_grouping: bool)

Setter for supportsGrouping.

pub unsafe fn txtRecordData(&self) -> Option<Retained<NSData>>

TXT record of the device.

pub unsafe fn setTxtRecordData(&self, txt_record_data: Option<&NSData>)

Setter for txtRecordData.

This is copied when set.

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

URL used for SSDP connection. The URL must have a valid hostname, no query parameters, and a maximum size of 100 bytes.

pub unsafe fn setUrl(&self, url: &NSURL)

Setter for url.

This is copied when set.

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

Device’s Wi-Fi Aware’s service name.

pub unsafe fn setWifiAwareServiceName( &self, wifi_aware_service_name: Option<&NSString>, )

Setter for wifiAwareServiceName.

This is copied when set.

pub unsafe fn wifiAwareServiceRole(&self) -> DDDeviceWiFiAwareServiceRole

Device’s Wi-Fi Aware’s service. Default is DDDeviceWiFiAwareServiceRoleSubscriber

pub unsafe fn setWifiAwareServiceRole( &self, wifi_aware_service_role: DDDeviceWiFiAwareServiceRole, )

Setter for wifiAwareServiceRole.

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

Device’s Wi-Fi Aware model name.

pub unsafe fn setWifiAwareModelName( &self, wifi_aware_model_name: Option<&NSString>, )

Setter for wifiAwareModelName.

This is copied when set.

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

Device’s Wi-Fi Aware vendor name.

pub unsafe fn setWifiAwareVendorName( &self, wifi_aware_vendor_name: Option<&NSString>, )

Setter for wifiAwareVendorName.

This is copied when set.

impl DDDevice

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 DDDevice

fn as_ref(&self) -> &AnyObject

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

impl AsRef<DDDevice> for DDDevice

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for DDDevice

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for DDDevice

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for DDDevice

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for DDDevice

const NAME: &'static str = "DDDevice"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<DDDevice 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 DDDevice

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

Formats the value using the given formatter.

impl Deref for DDDevice

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for DDDevice

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 DDDevice

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for DDDevice

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 DDDevice

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 DDDevice

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

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

impl DowncastTarget for DDDevice

impl Eq for DDDevice