Struct SBObject 

pub struct SBObject { /* private fields */ }

Available on crate feature SBObject only.

The SBObject class declares methods that can be invoked on any object in a scriptable application. It defines methods for getting elements and properties of an object, as well as setting a given object to a new value.

Each SBObject is built around an object specifier, which tells Scripting Bridge how to locate the object. Therefore, you can think of an SBObject as a reference to an object in an target application rather than an object itself. To bypass this reference-based approach and force evaluation, use the SBObject/get method.

Typically, rather than create SBObject instances explictly, you receive SBObject objects by calling methods of an SBApplication subclass. For example, if you wanted to get an SBObject representing the current iTunes track, you would use code like this (where iTunesTrack is a subclass of SBObject):

iTunesApplication *iTunes = [SBApplication applicationWithBundleIdentifier:
"
com.apple.iTunes"];
iTunesTrack *track = [iTunes currentTrack];

You can discover the names of dynamically generated classes such as iTunesApplication and iTunesTrack by examining the header file created by the sdp tool. Alternatively, you give these variables the dynamic Objective-C type id.

See also Apple’s documentation

Implementations

impl SBObject

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

Initializes and returns an instance of an SBObject subclass.

Scripting Bridge does not actually create an object in the target application until you add the object returned from this method to an element array (SBElementArray).

• Returns: An SBObject object or nil if the object could not be initialized.

pub unsafe fn initWithProperties( this: Allocated<Self>, properties: &NSDictionary, ) -> Retained<Self>

Returns an instance of an SBObject subclass initialized with the specified properties.

Scripting Bridge does not actually create an object in the target application until you add the object returned from this method to an element array (SBElementArray).

• Parameters:

• properties: A dictionary with keys specifying the names of properties (that is, attributes or to-one relationships) and the values for those properties.

• Returns: An SBObject object or nil if the object could not be initialized.

Safety

properties generic should be of the correct type.

pub unsafe fn initWithData( this: Allocated<Self>, data: &AnyObject, ) -> Retained<Self>

Returns an instance of an SBObject subclass initialized with the given data.

Scripting Bridge does not actually create an object in the target application until you add the object returned from this method to an element array (SBElementArray).

• Parameters:

• data: An object containing data for the new SBObject object. The data varies according to the type of scripting object to be created.

• Returns: An SBObject object or nil if the object could not be initialized.

Safety

data should be of the correct type.

pub unsafe fn get(&self) -> Option<Retained<AnyObject>>

Forces evaluation of the receiver, causing the real object to be returned immediately.

This method forces the current object reference (the receiver) to be evaluated, resulting in the return of the referenced object. By default, Scripting Bridge deals with references to objects until you actually request some concrete data from them or until you call the get method.

• Returns: For most properties, the result is a Foundation object such as an NSString. For properties with no Foundation equivalent, the result is an NSAppleEventDescriptor or another SBObject for most elements.

pub unsafe fn lastError(&self) -> Option<Retained<NSError>>

The error from the last event this object sent, or nil if it succeeded.

impl SBObject

Methods declared on superclass NSObject.

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

impl SBObject

SBGlueInterface.

pub unsafe fn initWithElementCode_properties_data( this: Allocated<Self>, code: DescType, properties: Option<&NSDictionary<NSString, AnyObject>>, data: Option<&AnyObject>, ) -> Retained<Self>

Available on crate feature objc2-core-services only.

Returns an instance of an SBObject subclass initialized with the specified properties and data and added to the designated element array.

Unlike the other initializers of this class, this method not only initializes the SBObject object but adds it to a specified element array. This method is the designated initializer.

• Parameters:

• code: A four-character code used to identify an element in the target application’s scripting interface. See <doc ://com.apple.documentation/documentation/applicationservices/apple_event_manager> for details.

• properties: A dictionary with <doc ://com.apple.documentation/documentation/foundation/nsnumber> keys specifying the four-character codes of properties (that is, attributes or to-one relationships) and the values for those properties. Pass nil if you are initializing the object by data only.

• data: An object containing data for the new SBObject object. The data varies according to the type of scripting object to be created. Pass nil if you initializing the object by properties only.

• Returns: An SBObject object or nil if the object could not be initialized.

Safety

• properties generic should be of the correct type.
• data should be of the correct type.

pub unsafe fn propertyWithCode(&self, code: AEKeyword) -> Retained<SBObject>

Available on crate feature objc2-core-services only.

Returns an object representing the specified property of the receiver.

SBObject subclasses use this method to implement application-specific property accessor methods. You should not need to call this method directly.

• Parameters:

• code: A four-character code that uniquely identifies a property of the receiver.

• Returns: An object representing the receiver’s property as identified by code.

pub unsafe fn propertyWithClass_code( &self, cls: &AnyClass, code: AEKeyword, ) -> Retained<SBObject>

Available on crate feature objc2-core-services only.

Returns an object of the designated scripting class representing the specified property of the receiver

SBObject subclasses use this method to implement application-specific property accessor methods. You should not need to call this method directly.

Note: This method doesn’t retrieve the value of the property. To get the value, call get.

• Parameters:

• class: The SBObject subclass with which to instantiate the object.

• code: A four-character code that uniquely identifies a property of the receiver.

• Returns: An instance of the designated class that represents the receiver’s property identified by code.

Safety

cls probably has further requirements.

pub unsafe fn elementArrayWithCode( &self, code: DescType, ) -> Retained<SBElementArray>

Available on crate features SBElementArray and objc2-core-services only.

Returns an array containing every child of the receiver with the given class-type code.

SBObject subclasses use this method to implement application-specific property accessor methods. You should not need to call this method directly.

Note: This method doesn’t retrieve the value of the property. To get the value, call get.

• Parameters:

• code: A four-character code that identifies a scripting class.

• Returns: An SBElementArray object containing every child of the receiver whose class matches code.

pub unsafe fn setTo(&self, value: Option<&AnyObject>)

Sets the receiver to a specified value.

You should not call this method directly.

• Parameters:
• value: The data the receiver should be set to. It can be an <doc ://com.apple.documentation/documentation/foundation/nsstring>, <doc ://com.apple.documentation/documentation/foundation/nsnumber>, <doc ://com.apple.documentation/documentation/foundation/nsarray>, SBObject, or any other type of object supported by the Scripting Bridge framework.

Safety

value should be of the correct type.

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 SBObject

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SBObject

fn as_ref(&self) -> &NSObject

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

impl AsRef<SBObject> for SBApplication

Available on crate feature SBApplication only.

fn as_ref(&self) -> &SBObject

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

impl AsRef<SBObject> for SBObject

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SBObject

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SBObject

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<SBObject> for SBApplication

Available on crate feature SBApplication only.

fn borrow(&self) -> &SBObject

Immutably borrows from an owned value.

impl ClassType for SBObject

const NAME: &'static str = "SBObject"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for SBObject

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SBObject

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 SBObject

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SBObject

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for SBObject

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 SBObject

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 SBObject

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

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

impl DowncastTarget for SBObject

impl Eq for SBObject