Struct NSCreateCommand

Source

pub struct NSCreateCommand { /* private fields */ }

Available on crate features NSScriptCommand and NSScriptStandardSuiteCommands only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSCreateCommand

Source

pub fn createClassDescription(&self) -> Retained<NSScriptClassDescription>

Available on crate features NSClassDescription and NSScriptClassDescription only.

Source

pub fn resolvedKeyDictionary( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate features NSDictionary and NSString only.

Source §

impl NSCreateCommand

Methods declared on superclass NSScriptCommand.

Source

pub fn initWithCommandDescription( this: Allocated<Self>, command_def: &NSScriptCommandDescription, ) -> Retained<Self>

Available on crate feature NSScriptCommandDescription only.

Source

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

Available on crate feature NSCoder only.

§Safety

in_coder possibly has further requirements.

Source §

impl NSCreateCommand

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

Methods from Deref<Target = NSScriptCommand>§

Source

pub fn commandDescription(&self) -> Retained<NSScriptCommandDescription>

Available on crate feature NSScriptCommandDescription only.

Source

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

Source

pub unsafe fn setDirectParameter(&self, direct_parameter: Option<&AnyObject>)

Setter for directParameter.

§Safety

direct_parameter should be of the correct type.

Source

pub fn receiversSpecifier(&self) -> Option<Retained<NSScriptObjectSpecifier>>

Available on crate feature NSScriptObjectSpecifiers only.

Source

pub fn setReceiversSpecifier( &self, receivers_specifier: Option<&NSScriptObjectSpecifier>, )

Available on crate feature NSScriptObjectSpecifiers only.

Setter for receiversSpecifier.

Source

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

Source

pub fn arguments(&self) -> Option<Retained<NSDictionary<NSString, AnyObject>>>

Available on crate features NSDictionary and NSString only.

Source

pub unsafe fn setArguments( &self, arguments: Option<&NSDictionary<NSString, AnyObject>>, )

Available on crate features NSDictionary and NSString only.

Setter for arguments.

This is copied when set.

§Safety

arguments generic should be of the correct type.

Source

pub fn evaluatedArguments( &self, ) -> Option<Retained<NSDictionary<NSString, AnyObject>>>

Available on crate features NSDictionary and NSString only.

Source

pub fn scriptErrorOffendingObjectDescriptor( &self, ) -> Option<Retained<NSAppleEventDescriptor>>

Available on crate feature NSAppleEventDescriptor only.

Source

pub fn setScriptErrorOffendingObjectDescriptor( &self, script_error_offending_object_descriptor: Option<&NSAppleEventDescriptor>, )

Available on crate feature NSAppleEventDescriptor only.

Setter for scriptErrorOffendingObjectDescriptor.

Source

pub fn scriptErrorExpectedTypeDescriptor( &self, ) -> Option<Retained<NSAppleEventDescriptor>>

Available on crate feature NSAppleEventDescriptor only.

Source

pub fn setScriptErrorExpectedTypeDescriptor( &self, script_error_expected_type_descriptor: Option<&NSAppleEventDescriptor>, )

Available on crate feature NSAppleEventDescriptor only.

Setter for scriptErrorExpectedTypeDescriptor.

Source

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

Available on crate feature NSString only.

Source

pub fn setScriptErrorString(&self, script_error_string: Option<&NSString>)

Available on crate feature NSString only.

Setter for scriptErrorString.

This is copied when set.

Source

pub fn appleEvent(&self) -> Option<Retained<NSAppleEventDescriptor>>

Available on crate feature NSAppleEventDescriptor only.

Source

pub fn suspendExecution(&self)

Source

pub unsafe fn resumeExecutionWithResult(&self, result: Option<&AnyObject>)

§Safety

result should be of the correct type.

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