Struct NSBundle

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

Available on crate feature NSBundle only.

Apple’s documentation

Implementations

impl NSBundle

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

Available on crate features NSString and NSDictionary only.

impl NSBundle

pub fn mainBundle() -> Retained<NSBundle>

pub unsafe fn bundleWithPath(path: &NSString) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn initWithPath( this: Allocated<Self>, path: &NSString, ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn bundleWithURL(url: &NSURL) -> Option<Retained<Self>>

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

pub unsafe fn bundleForClass(a_class: &AnyClass) -> Retained<NSBundle>

pub unsafe fn bundleWithIdentifier( identifier: &NSString, ) -> Option<Retained<NSBundle>>

Available on crate feature NSString only.

pub unsafe fn allBundles() -> Retained<NSArray<NSBundle>>

Available on crate feature NSArray only.

pub unsafe fn allFrameworks() -> Retained<NSArray<NSBundle>>

Available on crate feature NSArray only.

pub unsafe fn load(&self) -> bool

pub unsafe fn isLoaded(&self) -> bool

pub unsafe fn unload(&self) -> bool

pub unsafe fn preflightAndReturnError(&self) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn loadAndReturnError(&self) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

pub unsafe fn URLForAuxiliaryExecutable( &self, executable_name: &NSString, ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSURL only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn pathForAuxiliaryExecutable( &self, executable_name: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn URLForResource_withExtension_subdirectory_inBundleWithURL( name: Option<&NSString>, ext: Option<&NSString>, subpath: Option<&NSString>, bundle_url: &NSURL, ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

pub unsafe fn URLsForResourcesWithExtension_subdirectory_inBundleWithURL( ext: Option<&NSString>, subpath: Option<&NSString>, bundle_url: &NSURL, ) -> Option<Retained<NSArray<NSURL>>>

Available on crate features NSArray and NSString and NSURL only.

pub unsafe fn URLForResource_withExtension( &self, name: Option<&NSString>, ext: Option<&NSString>, ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

pub unsafe fn URLForResource_withExtension_subdirectory( &self, name: Option<&NSString>, ext: Option<&NSString>, subpath: Option<&NSString>, ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

pub unsafe fn URLForResource_withExtension_subdirectory_localization( &self, name: Option<&NSString>, ext: Option<&NSString>, subpath: Option<&NSString>, localization_name: Option<&NSString>, ) -> Option<Retained<NSURL>>

Available on crate features NSString and NSURL only.

pub unsafe fn URLsForResourcesWithExtension_subdirectory( &self, ext: Option<&NSString>, subpath: Option<&NSString>, ) -> Option<Retained<NSArray<NSURL>>>

Available on crate features NSArray and NSString and NSURL only.

pub unsafe fn URLsForResourcesWithExtension_subdirectory_localization( &self, ext: Option<&NSString>, subpath: Option<&NSString>, localization_name: Option<&NSString>, ) -> Option<Retained<NSArray<NSURL>>>

Available on crate features NSArray and NSString and NSURL only.

pub unsafe fn pathForResource_ofType_inDirectory_class( name: Option<&NSString>, ext: Option<&NSString>, bundle_path: &NSString, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn pathsForResourcesOfType_inDirectory_class( ext: Option<&NSString>, bundle_path: &NSString, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn pathForResource_ofType( &self, name: Option<&NSString>, ext: Option<&NSString>, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn pathForResource_ofType_inDirectory( &self, name: Option<&NSString>, ext: Option<&NSString>, subpath: Option<&NSString>, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn pathForResource_ofType_inDirectory_forLocalization( &self, name: Option<&NSString>, ext: Option<&NSString>, subpath: Option<&NSString>, localization_name: Option<&NSString>, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub unsafe fn pathsForResourcesOfType_inDirectory( &self, ext: Option<&NSString>, subpath: Option<&NSString>, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn pathsForResourcesOfType_inDirectory_forLocalization( &self, ext: Option<&NSString>, subpath: Option<&NSString>, localization_name: Option<&NSString>, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn localizedStringForKey_value_table( &self, key: &NSString, value: Option<&NSString>, table_name: Option<&NSString>, ) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn localizedStringForKey_value_table_localizations( &self, key: &NSString, value: Option<&NSString>, table_name: Option<&NSString>, localizations: &NSArray<NSString>, ) -> Retained<NSString>

Available on crate features NSArray and NSString only.

Look up a localized string given a list of available localizations.

• Parameters:
• key: The key for the localized string to retrieve.
• value: A default value to return if a localized string for key cannot be found.
• tableName: The name of the strings file to search. If nil, the method uses tables in Localizable.strings.
• localizations: An array of BCP 47 language codes corresponding to available localizations. Bundle compares the array against its available localizations, and uses the best result to retrieve the localized string. If empty, we treat it as no localization is available, and may return a fallback.
• Returns: A localized version of the string designated by key in table tableName.

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

Available on crate feature NSString only.

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

Available on crate features NSDictionary and NSString only.

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

Available on crate features NSDictionary and NSString only.

pub unsafe fn objectForInfoDictionaryKey( &self, key: &NSString, ) -> Option<Retained<AnyObject>>

Available on crate feature NSString only.

pub unsafe fn classNamed( &self, class_name: &NSString, ) -> Option<&'static AnyClass>

Available on crate feature NSString only.

pub unsafe fn principalClass(&self) -> Option<&'static AnyClass>

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate feature NSString only.

pub unsafe fn preferredLocalizationsFromArray( localizations_array: &NSArray<NSString>, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn preferredLocalizationsFromArray_forPreferences( localizations_array: &NSArray<NSString>, preferences_array: Option<&NSArray<NSString>>, ) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub unsafe fn executableArchitectures( &self, ) -> Option<Retained<NSArray<NSNumber>>>

Available on crate features NSArray and NSValue only.

impl NSBundle

Methods declared on superclass NSObject.

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

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

impl NSBundle

NSBundleResourceRequestAdditions.

pub unsafe fn setPreservationPriority_forTags( &self, priority: c_double, tags: &NSSet<NSString>, )

Available on crate features NSSet and NSString only.

pub unsafe fn preservationPriorityForTag(&self, tag: &NSString) -> c_double

Available on crate feature NSString only.

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 NSBundle

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSBundle> for NSBundle

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSBundle

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSBundle

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSBundle

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSBundle

const NAME: &'static str = "NSBundle"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSBundle

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSBundle

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 NSBundle

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSBundle

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 NSBundle

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 NSBundle

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

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

impl DowncastTarget for NSBundle

impl Eq for NSBundle

impl RefUnwindSafe for NSBundle

impl Send for NSBundle

impl Sync for NSBundle

impl UnwindSafe for NSBundle