Struct ICCameraFile

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

Available on crate features ICCameraFile and ICCameraItem only.

This class represents a file on an ICCameraDevice object.

See also Apple’s documentation

Implementations

impl ICCameraFile

pub unsafe fn width(&self) -> NSInteger

Width of an image or movie frame.

pub unsafe fn height(&self) -> NSInteger

Height of an image or movie frame.

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

Original filename on disk

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

Created filename

pub unsafe fn fileSize(&self) -> off_t

Available on crate feature libc only.

Size of file in bytes.

pub unsafe fn orientation(&self) -> ICEXIFOrientationType

Available on crate feature ImageCaptureConstants only.

Desired orientation of image to use when it is downloaded.

This property is set to ICEXIFOrientation1 initially. If the format of this file supports EXIF orientation tag, then this property will be updated to match the value of that tag, when the thumbnail or metadata for this file is received.

pub unsafe fn setOrientation(&self, orientation: ICEXIFOrientationType)

Available on crate feature ImageCaptureConstants only.

Setter for orientation.

pub unsafe fn duration(&self) -> c_double

Duration of audio/video file in seconds.

pub unsafe fn highFramerate(&self) -> bool

True if file is a slo-mo or high framerate video file, nil otherwise.

pub unsafe fn timeLapse(&self) -> bool

True if file is a time-lapse video file, nil otherwise.

pub unsafe fn firstPicked(&self) -> bool

True if file is a firstPicked nil otherwise.

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

originatingAssetID of file if present, nil if not a HEIF or HVEC.

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

groupUUID of file if present, nil if file has no groupUUID.

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

GPS String in standard format.

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

Internal related UUID for dbg/aae/etc.

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

burstUUID of file if present, nil if not in a burst.

pub unsafe fn burstFavorite(&self) -> bool

True if burst favorite, ignored if not in a burst or not a burst favorite.

pub unsafe fn burstPicked(&self) -> bool

True if burst user picked, ignored if not in a burst or not a burst user picked.

pub unsafe fn sidecarFiles(&self) -> Option<Retained<NSArray<ICCameraItem>>>

This property is NULL if there are no sidecar files associated with this file. Otherwise it is an array of ICCameraFile instances of sidecar files associated with this file. An example of a sidecar file is a file with the same base name as this file and having an extension XMP.

pub unsafe fn pairedRawImage(&self) -> Option<Retained<ICCameraFile>>

A single item subset of the sidecarFiles array, which contains the logical RAW compliment of a JPG or other format image.

pub unsafe fn fileCreationDate(&self) -> Option<Retained<NSDate>>

Properties will either represent the actual file creation date, or nil.

pub unsafe fn fileModificationDate(&self) -> Option<Retained<NSDate>>

Properties will either represent the actual file modification date, or nil.

pub unsafe fn exifCreationDate(&self) -> Option<Retained<NSDate>>

Properties will either represent the exif creation date, or nil.

pub unsafe fn exifModificationDate(&self) -> Option<Retained<NSDate>>

Properties will either represent the exif modification date, or nil.

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

A fingerprint generated from the camera file data date, or nil.

pub unsafe fn fingerprintForFileAtURL(url: &NSURL) -> Option<Retained<NSString>>

Generates a fingerprint given a URL date, or nil.

pub unsafe fn requestThumbnailDataWithOptions_completion( &self, options: Option<&NSDictionary<ICCameraItemThumbnailOption, AnyObject>>, completion: &DynBlock<dyn Fn(*mut NSData, *mut NSError)>, )

Available on crate feature block2 only.

Perform a thumbnail request and execute the block callback in place of the delegate.

Parameter options: Options dictionary

• ‘kCGImageSourceThumbnailMaxPixelSize’ - Request a width different from the embedded EXIF thumbnail

Parameter completion: Completion block called with an NSData* object representing the JPG, and an NSError* for status.

Note: The completion block will execute on an any available queue, often this will not be the main queue.

pub unsafe fn requestMetadataDictionaryWithOptions_completion( &self, options: Option<&NSDictionary<ICCameraItemMetadataOption, AnyObject>>, completion: &DynBlock<dyn Fn(*mut NSDictionary, *mut NSError)>, )

Available on crate feature block2 only.

Perform a metadata request and execute the block callback in place of the delegate.

Parameter options: Options dictionary

Parameter completion: Completion block called with an NSDictionary* object containing the metadata, and an NSError* for status.

Note: The completion block will execute on an any available queue, often this will not be the main queue.

pub unsafe fn requestDownloadWithOptions_completion( &self, options: Option<&NSDictionary<ICDownloadOption, AnyObject>>, completion: &DynBlock<dyn Fn(*mut NSString, *mut NSError)>, ) -> Option<Retained<NSProgress>>

Available on crate feature block2 only.

Perform a download request and execute the block callback in place of the delegate.

Parameter options: Dictionary Keys:

• ICDownloadsDirectoryURL
• ICSaveAsFilename
• ICOverwriteExistingFile
• ICDeleteAfterDownload
• ICAdjustCreationDate

Parameter completion: Completion block to executed after request has returned,

Note: The completion block will execute on an any available queue, often this will not be the main queue.

pub unsafe fn requestReadDataAtOffset_length_completion( &self, offset: off_t, length: off_t, completion: &DynBlock<dyn Fn(*mut NSData, *mut NSError)>, )

Available on crate features block2 and libc only.

This method asynchronously reads data of a specified length from a specified offset.

Parameter offset: The offset into the file to start reading from

Parameter length: The length of data to be read.

Parameter completion: Completion block called with an NSData* object representing the data, and an NSError* for status.

Note: The completion block will execute on an any available queue, often this will not be the main queue.

pub unsafe fn requestSecurityScopedURLWithCompletion( &self, completion: &DynBlock<dyn Fn(*mut NSURL, *mut NSError)>, )

Available on crate feature block2 only.

Requests a security scoped NSURL* for a media file on a mass storage volume. The returned NSURL* requires the use of startAccessingSecurityScopedResource, and stopAccessingSecurityScopedResource for access.

Parameter completion: Completion block called with an NSURL*, and an NSError* for status.

Note: The completion block will execute on an any available queue, often this will not be the main queue.

pub unsafe fn requestFingerprintWithCompletion( &self, completion: &DynBlock<dyn Fn(*mut NSString, *mut NSError)>, )

Available on crate feature block2 only.

Requests a fingerprint be generated for camera file.

Parameter completion: Completion block called with an NSString*, and an NSError* for status.

Note: The completion block will execute on an any available queue, often this will not be the main queue.

impl ICCameraFile

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = ICCameraItem>

pub unsafe fn device(&self) -> Option<Retained<ICCameraDevice>>

Available on crate features ICCameraDevice and ICDevice only.

Parent device of this item.

pub unsafe fn parentFolder(&self) -> Option<Retained<ICCameraFolder>>

Available on crate feature ICCameraFolder only.

Parent folder of this folder. The root folder’s parentFolder is nil.

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

Name of this item.

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

Item UTI. This is an Uniform Type Identifier string. It is one of: kUTTypeFolder, kUTTypeImage, kUTTypeMovie, kUTTypeAudio, or kUTTypeData.

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

The file system path of the item for items on a device with transportType of ICTransportTypeMassStorage.

pub unsafe fn isLocked(&self) -> bool

Indicates the protection state of this item. It is locked if the storage card in the camera is locked.

pub unsafe fn isRaw(&self) -> bool

Indicates if the file is a raw image file.

pub unsafe fn isInTemporaryStore(&self) -> bool

Indicates if this folder is in a temporary store. A temporary store may be used by the device when images are captures on the device when it is tethered to the computer.

pub unsafe fn creationDate(&self) -> Option<Retained<NSDate>>

Creation date of this file. This information is usually the same as the EXIF creation date.

pub unsafe fn modificationDate(&self) -> Option<Retained<NSDate>>

Modification date of this file. This information is usually the same as the EXIF modification date.

pub unsafe fn thumbnail(&self) -> Option<Retained<CGImage>>

Available on crate feature objc2-core-graphics only.

Thumbnail for the item. The value of this property is NULL unless a ‘requestThumbnail’ message is sent to this object.

pub unsafe fn metadata(&self) -> Option<Retained<NSDictionary>>

Metadata for the item. The value of this property is NULL unless a ‘requestMetadata’ message is sent to this object.

pub unsafe fn userData(&self) -> Option<Retained<NSMutableDictionary>>

A mutable dictionary to store arbitrary key-value pairs associated with a camera item object. This can be used by view objects that bind to this object to store “house-keeping” information.

pub unsafe fn ptpObjectHandle(&self) -> c_uint

PTP object handle value if the item is on a camera that uses PTP protocol. The value of this property is set to 0 if the camera does not use PTP protocol.

pub unsafe fn wasAddedAfterContentCatalogCompleted(&self) -> bool

This property is set if the file is captured on the device after the device’s content is fully enumerated. This does not apply to files added as a result of adding a new store to the device.

pub unsafe fn requestThumbnail(&self)

This method requests thumbnail for the item. If one is not readily available, accessing this property will send a message to the device requesting a thumbnail for the file. The delegate of the device will be notified via method “cameraDevice:didReceiveThumbnail:forItem:error:”, if this method is implemented by the delegate.

Note: Execution of the delegate callback will occur on the main thread.

pub unsafe fn requestMetadata(&self)

Metadata for the file if one is readily available. If one is not readily available, accessing this property will send a message to the device requesting metadata for the file. The delegate of the device will be notified via method “cameraDevice:didReceiveMetadata:forItem:error:”, if this method is implemented by the delegate.

Note: Execution of the delegate callback will occur on the main thread.

pub unsafe fn flushThumbnailCache(&self)

Deletes cached thumbnail for the item.

pub unsafe fn flushMetadataCache(&self)

Deletes cached metadata for the item.

pub unsafe fn thumbnailIfAvailable(&self) -> Option<Retained<CGImage>>

👎Deprecated

Available on crate feature objc2-core-graphics only.

pub unsafe fn largeThumbnailIfAvailable(&self) -> Option<Retained<CGImage>>

👎Deprecated

Available on crate feature objc2-core-graphics only.

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

👎Deprecated

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<AnyObject> for ICCameraFile

fn as_ref(&self) -> &AnyObject

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

impl AsRef<ICCameraFile> for ICCameraFile

fn as_ref(&self) -> &Self

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

impl AsRef<ICCameraItem> for ICCameraFile

fn as_ref(&self) -> &ICCameraItem

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

impl AsRef<NSObject> for ICCameraFile

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for ICCameraFile

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<ICCameraItem> for ICCameraFile

fn borrow(&self) -> &ICCameraItem

Immutably borrows from an owned value.

impl Borrow<NSObject> for ICCameraFile

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ICCameraFile

const NAME: &'static str = "ICCameraFile"

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

type Super = ICCameraItem

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for ICCameraFile

type Target = ICCameraItem

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ICCameraFile

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 ICCameraFile

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ICCameraFile

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 ICCameraFile

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 ICCameraFile

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

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

impl DowncastTarget for ICCameraFile

impl Eq for ICCameraFile