Struct ITLibrary 

pub struct ITLibrary { /* private fields */ }

Available on crate feature ITLibrary only.

A class representing an iTunes library whose metadata is being queried.

See also Apple’s documentation

Implementations

impl ITLibrary

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

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

The version of iTunes being accessed.

pub unsafe fn features(&self) -> ITLibExportFeature

A bitwise OR combination of the features of this library.

pub unsafe fn apiMajorVersion(&self) -> NSUInteger

The major version number of this API.

pub unsafe fn apiMinorVersion(&self) -> NSUInteger

The minor version number of this API.

pub unsafe fn mediaFolderLocation(&self) -> Option<Retained<NSURL>>

The location of the iTunes music folder.

pub unsafe fn musicFolderLocation(&self) -> Option<Retained<NSURL>>

The location of the iTunes music folder. Replaced by mediaFolderLocation.

pub unsafe fn shouldShowContentRating(&self) -> bool

Whether to show content rating labels.

pub unsafe fn allMediaItems(&self) -> Retained<NSArray<ITLibMediaItem>>

Available on crate features ITLibMediaEntity and ITLibMediaItem only.

All media items in the library.

pub unsafe fn allPlaylists(&self) -> Retained<NSArray<ITLibPlaylist>>

Available on crate features ITLibMediaEntity and ITLibPlaylist only.

All playlists in the library.

pub unsafe fn libraryWithAPIVersion_error( requested_api_version: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

Creates and initializes an instance of ITLibrary which can be used to retrieve media entities.

Upon initialization of the ITLibrary class, the default iTunes database for the current user will be read and parsed. At this point all media entities will be cached in memory until the time the object is deallocated.

Parameter requestedAPIVersion: The version of the iTunesLibrary API that the application is requesting, provide “1.0” if unknown.

Parameter error: A pointer to a variable that will receive an NSError if this method fails. May be nil if caller does not care about error.

Returns: An ITLibrary instance, or nil if this method fails.

pub unsafe fn libraryWithAPIVersion_options_error( requested_api_version: &NSString, options: ITLibInitOptions, ) -> Result<Retained<Self>, Retained<NSError>>

Creates and initializes an instance of ITLibrary which can be used to retrieve media entities.

Unless the ITLibInitOptionLazyLoadData option is specified, the default iTunes database for the current user will be read and parsed upon initialization of the ITLibrary class, and all media entities will be cached in memory.

Parameter requestedAPIVersion: The version of the iTunesLibrary API that the application is requesting, provide “1.0” if unknown.

Parameter options: Options that change the initialization behavior.

Parameter error: A pointer to a variable that will receive an NSError if this method fails. May be nil if caller does not care about error.

Returns: An ITLibrary instance, or nil if this method fails.

pub unsafe fn initWithAPIVersion_error( this: Allocated<Self>, requested_api_version: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

Initializes an instance of ITLibrary which can be used to retrieve media entities.

Upon initialization of the ITLibrary class, the default iTunes database for the current user will be read and parsed. At this point all media entities will be cached in memory until the time the object is deallocated.

Parameter requestedAPIVersion: The version of the iTunesLibrary API that the application is requesting, provide “1.0” if unknown.

Parameter error: A pointer to a variable that will receive an NSError if this method fails. May be nil if caller does not care about error.

Returns: An ITLibrary instance, or nil if this method fails.

pub unsafe fn initWithAPIVersion_options_error( this: Allocated<Self>, requested_api_version: &NSString, options: ITLibInitOptions, ) -> Result<Retained<Self>, Retained<NSError>>

Initializes an instance of ITLibrary which can be used to retrieve media entities.

Unless the ITLibInitOptionLazyLoadData option is specified, the default iTunes database for the current user will be read and parsed upon initialization of the ITLibrary class, and all media entities will be cached in memory.

Parameter requestedAPIVersion: The version of the iTunesLibrary API that the application is requesting, provide “1.0” if unknown.

Parameter options: Options that change the initialization behavior.

Parameter error: A pointer to a variable that will receive an NSError if this method fails. May be nil if caller does not care about error.

Returns: An ITLibrary instance, or nil if this method fails.

pub unsafe fn artworkForMediaFile( &self, media_file_url: &NSURL, ) -> Option<Retained<ITLibArtwork>>

Available on crate feature ITLibArtwork only.

Retrieves the artwork from a media file.

Parameter mediaFileURL: The URL of the media file whose artwork should be extracted.

Returns: A ITLibArtwork instance represeting the media file artwork, or nil if the artwork was not found or could not be extracted.

pub unsafe fn reloadData(&self) -> bool

Refreshes the data used by the framework.

Returns: YES if the data was reloaded, false if an error occurred.

pub unsafe fn unloadData(&self)

Unloads the data used by the framework.

impl ITLibrary

Methods declared on superclass NSObject.

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.

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 ITLibrary

fn as_ref(&self) -> &AnyObject

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

impl AsRef<ITLibrary> for ITLibrary

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for ITLibrary

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for ITLibrary

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ITLibrary

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ITLibrary

const NAME: &'static str = "ITLibrary"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for ITLibrary

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ITLibrary

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 ITLibrary

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ITLibrary

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 ITLibrary

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 ITLibrary

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

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

impl DowncastTarget for ITLibrary

impl Eq for ITLibrary