Struct NSMapTable

#[repr(C)]
pub struct NSMapTable<KeyType: ?Sized = AnyObject, ObjectType: ?Sized = AnyObject> { /* private fields */ }

Available on crate feature NSMapTable only.

Apple’s documentation

Implementations

impl<KeyType: Message, ObjectType: Message> NSMapTable<KeyType, ObjectType>

pub unsafe fn initWithKeyOptions_valueOptions_capacity( this: Allocated<Self>, key_options: NSPointerFunctionsOptions, value_options: NSPointerFunctionsOptions, initial_capacity: NSUInteger, ) -> Retained<Self>

Available on crate feature NSPointerFunctions only.

pub unsafe fn initWithKeyPointerFunctions_valuePointerFunctions_capacity( this: Allocated<Self>, key_functions: &NSPointerFunctions, value_functions: &NSPointerFunctions, initial_capacity: NSUInteger, ) -> Retained<Self>

Available on crate feature NSPointerFunctions only.

pub unsafe fn mapTableWithKeyOptions_valueOptions( key_options: NSPointerFunctionsOptions, value_options: NSPointerFunctionsOptions, ) -> Retained<NSMapTable<KeyType, ObjectType>>

Available on crate feature NSPointerFunctions only.

pub unsafe fn mapTableWithStrongToStrongObjects() -> Retained<AnyObject>

👎Deprecated: GC no longer supported

pub unsafe fn mapTableWithWeakToStrongObjects() -> Retained<AnyObject>

👎Deprecated: GC no longer supported

pub unsafe fn mapTableWithStrongToWeakObjects() -> Retained<AnyObject>

👎Deprecated: GC no longer supported

pub unsafe fn mapTableWithWeakToWeakObjects() -> Retained<AnyObject>

👎Deprecated: GC no longer supported

pub unsafe fn strongToStrongObjectsMapTable() -> Retained<NSMapTable<KeyType, ObjectType>>

pub unsafe fn weakToStrongObjectsMapTable() -> Retained<NSMapTable<KeyType, ObjectType>>

pub unsafe fn strongToWeakObjectsMapTable() -> Retained<NSMapTable<KeyType, ObjectType>>

pub unsafe fn weakToWeakObjectsMapTable() -> Retained<NSMapTable<KeyType, ObjectType>>

pub unsafe fn keyPointerFunctions(&self) -> Retained<NSPointerFunctions>

Available on crate feature NSPointerFunctions only.

pub unsafe fn valuePointerFunctions(&self) -> Retained<NSPointerFunctions>

Available on crate feature NSPointerFunctions only.

pub unsafe fn objectForKey( &self, a_key: Option<&KeyType>, ) -> Option<Retained<ObjectType>>

pub unsafe fn removeObjectForKey(&self, a_key: Option<&KeyType>)

pub unsafe fn setObject_forKey( &self, an_object: Option<&ObjectType>, a_key: Option<&KeyType>, )

pub unsafe fn count(&self) -> NSUInteger

pub unsafe fn keyEnumerator(&self) -> Retained<NSEnumerator<KeyType>>

Available on crate feature NSEnumerator only.

pub unsafe fn objectEnumerator( &self, ) -> Option<Retained<NSEnumerator<ObjectType>>>

Available on crate feature NSEnumerator only.

pub unsafe fn removeAllObjects(&self)

pub unsafe fn dictionaryRepresentation( &self, ) -> Retained<NSDictionary<KeyType, ObjectType>>

Available on crate feature NSDictionary only.

impl<KeyType: Message, ObjectType: Message> NSMapTable<KeyType, ObjectType>

Methods declared on superclass NSObject.

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

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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<AnyObject> for NSMapTable<KeyType, ObjectType>

fn as_ref(&self) -> &AnyObject

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<NSMapTable<KeyType, ObjectType>> for NSMapTable<KeyType, ObjectType>

fn as_ref(&self) -> &Self

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<NSObject> for NSMapTable<KeyType, ObjectType>

fn as_ref(&self) -> &NSObject

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Borrow<AnyObject> for NSMapTable<KeyType, ObjectType>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Borrow<NSObject> for NSMapTable<KeyType, ObjectType>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> ClassType for NSMapTable<KeyType, ObjectType>

const NAME: &'static str = "NSMapTable"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSMapTable<KeyType, ObjectType> 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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> CopyingHelper for NSMapTable<KeyType, ObjectType>

Available on crate feature NSObject only.

type Result = NSMapTable<KeyType, ObjectType>

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl<KeyType: ?Sized, ObjectType: ?Sized> Debug for NSMapTable<KeyType, ObjectType>

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

Formats the value using the given formatter.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Deref for NSMapTable<KeyType, ObjectType>

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl<KeyType: ?Sized, ObjectType: ?Sized> Hash for NSMapTable<KeyType, ObjectType>

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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Message for NSMapTable<KeyType, ObjectType>

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

where Self: Sized,

Increment the reference count of the receiver.

impl<KeyType: ?Sized + NSCoding, ObjectType: ?Sized + NSCoding> NSCoding for NSMapTable<KeyType, ObjectType>

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl<KeyType: ?Sized, ObjectType: ?Sized> NSCopying for NSMapTable<KeyType, ObjectType>

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

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

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

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

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

impl<KeyType: ?Sized, ObjectType: ?Sized> NSFastEnumeration for NSMapTable<KeyType, ObjectType>

unsafe fn countByEnumeratingWithState_objects_count( &self, state: NonNull<NSFastEnumerationState>, buffer: NonNull<*mut AnyObject>, len: NSUInteger, ) -> NSUInteger

where Self: Sized + Message,

Available on crate feature NSEnumerator only.

impl<KeyType: ?Sized, ObjectType: ?Sized> NSObjectProtocol for NSMapTable<KeyType, ObjectType>

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<KeyType: ?Sized + NSSecureCoding, ObjectType: ?Sized + NSSecureCoding> NSSecureCoding for NSMapTable<KeyType, ObjectType>

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl<KeyType: ?Sized, ObjectType: ?Sized> PartialEq for NSMapTable<KeyType, ObjectType>

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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> RefEncode for NSMapTable<KeyType, ObjectType>

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

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

impl DowncastTarget for NSMapTable<AnyObject, AnyObject>

impl<KeyType: ?Sized, ObjectType: ?Sized> Eq for NSMapTable<KeyType, ObjectType>