Struct AMBundleAction

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

Available on crate features AMAction and AMBundleAction only.

Apple’s documentation

Implementations

impl AMBundleAction

pub unsafe fn awakeFromBundle(&self)

pub unsafe fn hasView(&self) -> bool

pub unsafe fn view(&self, mtm: MainThreadMarker) -> Option<Retained<NSView>>

Available on crate feature objc2-app-kit only.

pub unsafe fn bundle(&self) -> Retained<NSBundle>

pub unsafe fn parameters( &self, ) -> Option<Retained<NSMutableDictionary<NSString, AnyObject>>>

pub unsafe fn setParameters( &self, parameters: Option<&NSMutableDictionary<NSString, AnyObject>>, )

Setter for parameters.

impl AMBundleAction

Methods declared on superclass AMAction.

pub unsafe fn initWithDefinition_fromArchive( this: Allocated<Self>, dict: Option<&NSDictionary<NSString, AnyObject>>, archived: bool, ) -> Option<Retained<Self>>

pub unsafe fn initWithContentsOfURL_error( this: Allocated<Self>, file_url: &NSURL, ) -> Result<Retained<Self>, Retained<NSError>>

impl AMBundleAction

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = AMAction>

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

pub unsafe fn ignoresInput(&self) -> bool

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

pub unsafe fn setSelectedInputType( &self, selected_input_type: Option<&NSString>, )

Setter for selectedInputType.

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

pub unsafe fn setSelectedOutputType( &self, selected_output_type: Option<&NSString>, )

Setter for selectedOutputType.

pub unsafe fn progressValue(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setProgressValue(&self, progress_value: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for progressValue.

pub unsafe fn runWithInput_fromAction_error( &self, input: Option<&AnyObject>, an_action: Option<&AMAction>, error_info: Option<&mut Option<Retained<NSDictionary<NSString, AnyObject>>>>, ) -> Option<Retained<AnyObject>>

👎Deprecated

pub unsafe fn runWithInput_error( &self, input: Option<&AnyObject>, ) -> Result<Retained<AnyObject>, Retained<NSError>>

pub unsafe fn runAsynchronouslyWithInput(&self, input: Option<&AnyObject>)

pub unsafe fn willFinishRunning(&self)

pub unsafe fn didFinishRunningWithError( &self, error_info: Option<&NSDictionary<NSString, AnyObject>>, )

👎Deprecated

pub unsafe fn finishRunningWithError(&self, error: Option<&NSError>)

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

pub unsafe fn setOutput(&self, output: Option<&AnyObject>)

Setter for output.

pub unsafe fn stop(&self)

pub unsafe fn reset(&self)

pub unsafe fn writeToDictionary( &self, dictionary: &NSMutableDictionary<NSString, AnyObject>, )

pub unsafe fn opened(&self)

pub unsafe fn activated(&self)

pub unsafe fn closed(&self)

pub unsafe fn updateParameters(&self)

pub unsafe fn parametersUpdated(&self)

pub unsafe fn isStopped(&self) -> bool

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<AMAction> for AMBundleAction

fn as_ref(&self) -> &AMAction

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

impl AsRef<AMBundleAction> for AMAppleScriptAction

Available on crate feature AMAppleScriptAction only.

fn as_ref(&self) -> &AMBundleAction

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

impl AsRef<AMBundleAction> for AMBundleAction

fn as_ref(&self) -> &Self

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

impl AsRef<AMBundleAction> for AMShellScriptAction

Available on crate feature AMShellScriptAction only.

fn as_ref(&self) -> &AMBundleAction

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

impl AsRef<AnyObject> for AMBundleAction

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AMBundleAction

fn as_ref(&self) -> &NSObject

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

impl Borrow<AMAction> for AMBundleAction

fn borrow(&self) -> &AMAction

Immutably borrows from an owned value.

impl Borrow<AMBundleAction> for AMAppleScriptAction

Available on crate feature AMAppleScriptAction only.

fn borrow(&self) -> &AMBundleAction

Immutably borrows from an owned value.

impl Borrow<AMBundleAction> for AMShellScriptAction

Available on crate feature AMShellScriptAction only.

fn borrow(&self) -> &AMBundleAction

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AMBundleAction

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AMBundleAction

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AMBundleAction

const NAME: &'static str = "AMBundleAction"

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

type Super = AMAction

The superclass of this class.

type ThreadKind = <<AMBundleAction 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 CopyingHelper for AMBundleAction

type Result = AMBundleAction

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for AMBundleAction

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

Formats the value using the given formatter.

impl Deref for AMBundleAction

type Target = AMAction

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AMBundleAction

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 AMBundleAction

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for AMBundleAction

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

where Self: Sized + Message,

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

where Self: Sized + Message,

impl NSCopying for AMBundleAction

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for AMBundleAction

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 NSSecureCoding for AMBundleAction

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for AMBundleAction

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 AMBundleAction

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

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

impl DowncastTarget for AMBundleAction

impl Eq for AMBundleAction