Struct objc2_osa_kit::OSAScript

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

Available on crate feature OSAScript only.

Implementations

impl OSAScript

pub unsafe fn scriptDataDescriptorWithContentsOfURL( url: &NSURL ) -> Option<Id<NSAppleEventDescriptor>>

pub unsafe fn initWithSource( this: Allocated<Self>, source: &NSString ) -> Id<Self>

pub unsafe fn initWithSource_language( this: Allocated<Self>, source: &NSString, language: Option<&OSALanguage> ) -> Id<Self>

Available on crate feature OSALanguage only.

pub unsafe fn initWithSource_fromURL_languageInstance_usingStorageOptions( this: Allocated<Self>, source: &NSString, url: Option<&NSURL>, instance: Option<&OSALanguageInstance>, storage_options: OSAStorageOptions ) -> Id<Self>

Available on crate feature OSALanguageInstance only.

pub unsafe fn initWithContentsOfURL_error( this: Allocated<Self>, url: &NSURL, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<Self>>

pub unsafe fn initWithContentsOfURL_language_error( this: Allocated<Self>, url: &NSURL, language: &OSALanguage, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Id<Self>

👎Deprecated

Available on crate feature OSALanguage only.

pub unsafe fn initWithContentsOfURL_languageInstance_usingStorageOptions_error( this: Allocated<Self>, url: &NSURL, instance: Option<&OSALanguageInstance>, storage_options: OSAStorageOptions ) -> Result<Id<Self>, Id<NSError>>

Available on crate feature OSALanguageInstance only.

pub unsafe fn initWithCompiledData_error( this: Allocated<Self>, data: &NSData, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Id<Self>

👎Deprecated

pub unsafe fn initWithCompiledData_fromURL_usingStorageOptions_error( this: Allocated<Self>, data: &NSData, url: Option<&NSURL>, storage_options: OSAStorageOptions ) -> Result<Id<Self>, Id<NSError>>

pub unsafe fn initWithScriptDataDescriptor_fromURL_languageInstance_usingStorageOptions_error( this: Allocated<Self>, data: &NSAppleEventDescriptor, url: Option<&NSURL>, instance: Option<&OSALanguageInstance>, storage_options: OSAStorageOptions ) -> Result<Id<Self>, Id<NSError>>

Available on crate feature OSALanguageInstance only.

pub unsafe fn source(&self) -> Id<NSString>

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

pub unsafe fn language(&self) -> Id<OSALanguage>

Available on crate feature OSALanguage only.

pub unsafe fn setLanguage(&self, language: &OSALanguage)

Available on crate feature OSALanguage only.

pub unsafe fn languageInstance(&self) -> Id<OSALanguageInstance>

Available on crate feature OSALanguageInstance only.

pub unsafe fn setLanguageInstance( &self, language_instance: &OSALanguageInstance )

Available on crate feature OSALanguageInstance only.

pub unsafe fn isCompiled(&self) -> bool

pub unsafe fn compileAndReturnError( &self, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> bool

pub unsafe fn executeAndReturnError( &self, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<NSAppleEventDescriptor>>

pub unsafe fn executeAppleEvent_error( &self, event: &NSAppleEventDescriptor, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<NSAppleEventDescriptor>>

pub unsafe fn executeAndReturnDisplayValue_error( &self, display_value: &mut Option<Id<NSAttributedString>>, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<NSAppleEventDescriptor>>

pub unsafe fn executeHandlerWithName_arguments_error( &self, name: &NSString, arguments: &NSArray, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<NSAppleEventDescriptor>>

pub unsafe fn richTextSource(&self) -> Option<Id<NSAttributedString>>

pub unsafe fn richTextFromDescriptor( &self, descriptor: &NSAppleEventDescriptor ) -> Option<Id<NSAttributedString>>

pub unsafe fn writeToURL_ofType_error( &self, url: &NSURL, type: &NSString, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> bool

pub unsafe fn writeToURL_ofType_usingStorageOptions_error( &self, url: &NSURL, type: &NSString, storage_options: OSAStorageOptions, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> bool

pub unsafe fn compiledDataForType_usingStorageOptions_error( &self, type: &NSString, storage_options: OSAStorageOptions, error_info: Option<&mut Option<Id<NSDictionary<NSString, AnyObject>>>> ) -> Option<Id<NSData>>

impl OSAScript

Methods declared on superclass NSObject

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

pub unsafe fn new() -> Id<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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for OSAScript

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for OSAScript

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<OSAScript> for OSAScript

fn as_mut(&mut self) -> &mut Self

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

impl AsRef<AnyObject> for OSAScript

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for OSAScript

fn as_ref(&self) -> &NSObject

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

impl AsRef<OSAScript> for OSAScript

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for OSAScript

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for OSAScript

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for OSAScript

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for OSAScript

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for OSAScript

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "OSAScript"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for OSAScript

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

Formats the value using the given formatter.

impl Deref for OSAScript

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for OSAScript

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for OSAScript

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 NSCopying for OSAScript

fn copy(&self) -> Id<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

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

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

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

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

impl NSObjectProtocol for OSAScript

fn isEqual(&self, other: &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,

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) -> Id<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Id<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 OSAScript

fn eq(&self, other: &OSAScript) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for OSAScript

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

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

impl Eq for OSAScript

impl Message for OSAScript

impl StructuralPartialEq for OSAScript