Struct NSScriptCommand

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

Available on crate feature NSScriptCommand only.

Apple’s documentation

Implementations

impl NSScriptCommand

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

Available on crate feature NSScriptCommandDescription only.

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

Available on crate feature NSCoder only.

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

Available on crate feature NSScriptCommandDescription only.

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

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

Setter for directParameter.

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

Available on crate feature NSScriptObjectSpecifiers only.

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

Available on crate feature NSScriptObjectSpecifiers only.

Setter for receiversSpecifier.

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

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

Available on crate features NSDictionary and NSString only.

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

Available on crate features NSDictionary and NSString only.

Setter for arguments.

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

Available on crate features NSDictionary and NSString only.

pub unsafe fn isWellFormed(&self) -> bool

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

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

pub unsafe fn scriptErrorNumber(&self) -> NSInteger

pub unsafe fn setScriptErrorNumber(&self, script_error_number: NSInteger)

Setter for scriptErrorNumber.

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

Available on crate feature NSAppleEventDescriptor only.

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

Available on crate feature NSAppleEventDescriptor only.

Setter for scriptErrorOffendingObjectDescriptor.

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

Available on crate feature NSAppleEventDescriptor only.

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

Available on crate feature NSAppleEventDescriptor only.

Setter for scriptErrorExpectedTypeDescriptor.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

Setter for scriptErrorString.

pub unsafe fn currentCommand() -> Option<Retained<NSScriptCommand>>

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

Available on crate feature NSAppleEventDescriptor only.

pub unsafe fn suspendExecution(&self)

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

impl NSScriptCommand

Methods declared on superclass NSObject.

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

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.

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 NSScriptCommand

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSScriptCommand

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSScriptCommand> for NSCloneCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSCloseCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSCountCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSCreateCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSDeleteCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSExistsCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSGetCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSMoveCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSQuitCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl AsRef<NSScriptCommand> for NSScriptCommand

fn as_ref(&self) -> &Self

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

impl AsRef<NSScriptCommand> for NSSetCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn as_ref(&self) -> &NSScriptCommand

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

impl Borrow<AnyObject> for NSScriptCommand

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSScriptCommand

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSCloneCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSCloseCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSCountCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSCreateCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSDeleteCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSExistsCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSGetCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSMoveCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSQuitCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl Borrow<NSScriptCommand> for NSSetCommand

Available on crate feature NSScriptStandardSuiteCommands only.

fn borrow(&self) -> &NSScriptCommand

Immutably borrows from an owned value.

impl ClassType for NSScriptCommand

const NAME: &'static str = "NSScriptCommand"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSScriptCommand

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSScriptCommand

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 NSScriptCommand

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSScriptCommand

Available on crate feature NSObject only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for NSScriptCommand

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 NSScriptCommand

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 NSScriptCommand

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

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

impl DowncastTarget for NSScriptCommand

impl Eq for NSScriptCommand