Struct NSItemProvider

Source

pub struct NSItemProvider { /* private fields */ }

Available on crate feature NSItemProvider only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSItemProvider

Source

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

Source

pub unsafe fn registerDataRepresentationForTypeIdentifier_visibility_loadHandler( &self, type_identifier: &NSString, visibility: NSItemProviderRepresentationVisibility, load_handler: &DynBlock<dyn Fn(NonNull<DynBlock<dyn Fn(mut NSData, mut NSError)>>) -> *mut NSProgress>, )

Available on crate features NSData and NSError and NSProgress and NSString and block2 only.

§Safety

load_handler block must be sendable.

Source

pub unsafe fn registerFileRepresentationForTypeIdentifier_fileOptions_visibility_loadHandler( &self, type_identifier: &NSString, file_options: NSItemProviderFileOptions, visibility: NSItemProviderRepresentationVisibility, load_handler: &DynBlock<dyn Fn(NonNull<DynBlock<dyn Fn(mut NSURL, Bool, mut NSError)>>) -> *mut NSProgress>, )

Available on crate features NSError and NSProgress and NSString and NSURL and block2 only.

§Safety

load_handler block must be sendable.

Source

pub fn registeredTypeIdentifiers(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

Source

pub fn registeredTypeIdentifiersWithFileOptions( &self, file_options: NSItemProviderFileOptions, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

Source

pub fn hasItemConformingToTypeIdentifier( &self, type_identifier: &NSString, ) -> bool

Available on crate feature NSString only.

Source

pub fn hasRepresentationConformingToTypeIdentifier_fileOptions( &self, type_identifier: &NSString, file_options: NSItemProviderFileOptions, ) -> bool

Available on crate feature NSString only.

Source

pub unsafe fn loadDataRepresentationForTypeIdentifier_completionHandler( &self, type_identifier: &NSString, completion_handler: &DynBlock<dyn Fn(mut NSData, mut NSError)>, ) -> Retained<NSProgress>

Available on crate features NSData and NSError and NSProgress and NSString and block2 only.

§Safety

completion_handler block must be sendable.

Source

pub unsafe fn loadFileRepresentationForTypeIdentifier_completionHandler( &self, type_identifier: &NSString, completion_handler: &DynBlock<dyn Fn(mut NSURL, mut NSError)>, ) -> Retained<NSProgress>

Available on crate features NSError and NSProgress and NSString and NSURL and block2 only.

§Safety

completion_handler block must be sendable.

Source

pub unsafe fn loadInPlaceFileRepresentationForTypeIdentifier_completionHandler( &self, type_identifier: &NSString, completion_handler: &DynBlock<dyn Fn(mut NSURL, Bool, mut NSError)>, ) -> Retained<NSProgress>

Available on crate features NSError and NSProgress and NSString and NSURL and block2 only.

§Safety

completion_handler block must be sendable.

Source

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

Available on crate feature NSString only.

Source

pub fn setSuggestedName(&self, suggested_name: Option<&NSString>)

Available on crate feature NSString only.

Setter for suggestedName.

This is copied when set.

Source

pub fn initWithObject( this: Allocated<Self>, object: &ProtocolObject<dyn NSItemProviderWriting>, ) -> Retained<Self>

Source

pub fn registerObject_visibility( &self, object: &ProtocolObject<dyn NSItemProviderWriting>, visibility: NSItemProviderRepresentationVisibility, )

Source

pub unsafe fn initWithItem_typeIdentifier( this: Allocated<Self>, item: Option<&ProtocolObject<dyn NSSecureCoding>>, type_identifier: Option<&NSString>, ) -> Retained<Self>

Available on crate features NSObject and NSString only.

§Safety

item should be of the correct type.

Source

pub unsafe fn initWithContentsOfURL( this: Allocated<Self>, file_url: Option<&NSURL>, ) -> Option<Retained<Self>>

Available on crate feature NSURL only.

§Safety

file_url might not allow None.

Source

pub unsafe fn registerItemForTypeIdentifier_loadHandler( &self, type_identifier: &NSString, load_handler: NSItemProviderLoadHandler, )

Available on crate features NSDictionary and NSError and NSObject and NSString and block2 only.

§Safety

load_handler must be a valid pointer.

Source

pub unsafe fn loadItemForTypeIdentifier_options_completionHandler( &self, type_identifier: &NSString, options: Option<&NSDictionary>, completion_handler: NSItemProviderCompletionHandler, )

Available on crate features NSDictionary and NSError and NSObject and NSString and block2 only.

§Safety

options generic should be of the correct type.
completion_handler must be a valid pointer or null.

Source §

impl NSItemProvider

Methods declared on superclass NSObject.

Source

pub fn new() -> Retained<Self>

Source §

impl NSItemProvider

NSPreviewSupport.

Source

pub unsafe fn previewImageHandler(&self) -> NSItemProviderLoadHandler

Available on crate features NSDictionary and NSError and NSObject and block2 only.

§Safety

The returned block must be sendable.

Source

pub unsafe fn setPreviewImageHandler( &self, preview_image_handler: NSItemProviderLoadHandler, )

Available on crate features NSDictionary and NSError and NSObject and block2 only.

Setter for previewImageHandler.

This is copied when set.

§Safety

preview_image_handler must be a valid pointer or null.

Source

pub unsafe fn loadPreviewImageWithOptions_completionHandler( &self, options: Option<&NSDictionary>, completion_handler: NSItemProviderCompletionHandler, )

Available on crate features NSDictionary and NSError and NSObject and block2 only.

§Safety

options generic should be of the correct type.
options might not allow None.
completion_handler must be a valid pointer.

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