Struct NSOrderedSet

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

Available on crate feature NSOrderedSet only.

************** Immutable Ordered Set ***************

See also Apple’s documentation

Implementations

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSKeyValueCoding.

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

Available on crate features NSKeyValueCoding and NSString only.

pub unsafe fn setValue_forKey(&self, value: Option<&AnyObject>, key: &NSString)

Available on crate features NSKeyValueCoding and NSString only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSKeyValueObserverRegistration.

pub unsafe fn addObserver_forKeyPath_options_context( &self, observer: &NSObject, key_path: &NSString, options: NSKeyValueObservingOptions, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSString only.

pub unsafe fn removeObserver_forKeyPath_context( &self, observer: &NSObject, key_path: &NSString, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSString only.

pub unsafe fn removeObserver_forKeyPath( &self, observer: &NSObject, key_path: &NSString, )

Available on crate features NSKeyValueObserving and NSString only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

pub unsafe fn count(&self) -> NSUInteger

pub unsafe fn objectAtIndex(&self, idx: NSUInteger) -> Retained<ObjectType>

pub unsafe fn indexOfObject(&self, object: &ObjectType) -> NSUInteger

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

pub unsafe fn initWithObjects_count( this: Allocated<Self>, objects: *mut NonNull<ObjectType>, cnt: NSUInteger, ) -> Retained<Self>

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

Available on crate feature NSCoder only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

Methods declared on superclass NSObject.

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

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSExtendedOrderedSet.

pub unsafe fn getObjects_range( &self, objects: *mut NonNull<ObjectType>, range: NSRange, )

Available on crate feature NSRange only.

pub unsafe fn objectsAtIndexes( &self, indexes: &NSIndexSet, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSArray and NSIndexSet only.

pub unsafe fn firstObject(&self) -> Option<Retained<ObjectType>>

pub unsafe fn lastObject(&self) -> Option<Retained<ObjectType>>

pub unsafe fn isEqualToOrderedSet( &self, other: &NSOrderedSet<ObjectType>, ) -> bool

pub unsafe fn containsObject(&self, object: &ObjectType) -> bool

pub unsafe fn intersectsOrderedSet( &self, other: &NSOrderedSet<ObjectType>, ) -> bool

pub unsafe fn intersectsSet(&self, set: &NSSet<ObjectType>) -> bool

Available on crate feature NSSet only.

pub unsafe fn isSubsetOfOrderedSet( &self, other: &NSOrderedSet<ObjectType>, ) -> bool

pub unsafe fn isSubsetOfSet(&self, set: &NSSet<ObjectType>) -> bool

Available on crate feature NSSet only.

pub unsafe fn objectAtIndexedSubscript( &self, idx: NSUInteger, ) -> Retained<ObjectType>

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

Available on crate feature NSEnumerator only.

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

Available on crate feature NSEnumerator only.

pub unsafe fn reversedOrderedSet(&self) -> Retained<NSOrderedSet<ObjectType>>

pub unsafe fn array(&self) -> Retained<NSArray<ObjectType>>

Available on crate feature NSArray only.

pub unsafe fn set(&self) -> Retained<NSSet<ObjectType>>

Available on crate feature NSSet only.

pub unsafe fn enumerateObjectsUsingBlock( &self, block: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate feature block2 only.

pub unsafe fn enumerateObjectsWithOptions_usingBlock( &self, opts: NSEnumerationOptions, block: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate features NSObjCRuntime and block2 only.

pub unsafe fn enumerateObjectsAtIndexes_options_usingBlock( &self, s: &NSIndexSet, opts: NSEnumerationOptions, block: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.

pub unsafe fn indexOfObjectPassingTest( &self, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate feature block2 only.

pub unsafe fn indexOfObjectWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate features NSObjCRuntime and block2 only.

pub unsafe fn indexOfObjectAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.

pub unsafe fn indexesOfObjectsPassingTest( &self, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and block2 only.

pub unsafe fn indexesOfObjectsWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.

pub unsafe fn indexesOfObjectsAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &Block<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.

pub unsafe fn indexOfObject_inSortedRange_options_usingComparator( &self, object: &ObjectType, range: NSRange, opts: NSBinarySearchingOptions, cmp: NSComparator, ) -> NSUInteger

Available on crate features NSArray and NSObjCRuntime and NSRange and block2 only.

pub unsafe fn sortedArrayUsingComparator( &self, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSArray and NSObjCRuntime and block2 only.

pub unsafe fn sortedArrayWithOptions_usingComparator( &self, opts: NSSortOptions, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSArray and NSObjCRuntime and block2 only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn descriptionWithLocale_indent( &self, locale: Option<&AnyObject>, level: NSUInteger, ) -> Retained<NSString>

Available on crate feature NSString only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSOrderedSetCreation.

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

pub unsafe fn orderedSetWithObject(object: &ObjectType) -> Retained<Self>

pub unsafe fn orderedSetWithObjects_count( objects: NonNull<NonNull<ObjectType>>, cnt: NSUInteger, ) -> Retained<Self>

pub unsafe fn orderedSetWithOrderedSet( set: &NSOrderedSet<ObjectType>, ) -> Retained<Self>

pub unsafe fn orderedSetWithOrderedSet_range_copyItems( set: &NSOrderedSet<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>

Available on crate feature NSRange only.

pub unsafe fn orderedSetWithArray(array: &NSArray<ObjectType>) -> Retained<Self>

Available on crate feature NSArray only.

pub unsafe fn orderedSetWithArray_range_copyItems( array: &NSArray<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>

Available on crate features NSArray and NSRange only.

pub unsafe fn orderedSetWithSet(set: &NSSet<ObjectType>) -> Retained<Self>

Available on crate feature NSSet only.

pub unsafe fn orderedSetWithSet_copyItems( set: &NSSet<ObjectType>, flag: bool, ) -> Retained<Self>

Available on crate feature NSSet only.

pub unsafe fn initWithObject( this: Allocated<Self>, object: &ObjectType, ) -> Retained<Self>

pub unsafe fn initWithOrderedSet( this: Allocated<Self>, set: &NSOrderedSet<ObjectType>, ) -> Retained<Self>

pub unsafe fn initWithOrderedSet_copyItems( this: Allocated<Self>, set: &NSOrderedSet<ObjectType>, flag: bool, ) -> Retained<Self>

pub unsafe fn initWithOrderedSet_range_copyItems( this: Allocated<Self>, set: &NSOrderedSet<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>

Available on crate feature NSRange only.

pub unsafe fn initWithArray( this: Allocated<Self>, array: &NSArray<ObjectType>, ) -> Retained<Self>

Available on crate feature NSArray only.

pub unsafe fn initWithArray_copyItems( this: Allocated<Self>, set: &NSArray<ObjectType>, flag: bool, ) -> Retained<Self>

Available on crate feature NSArray only.

pub unsafe fn initWithArray_range_copyItems( this: Allocated<Self>, set: &NSArray<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>

Available on crate features NSArray and NSRange only.

pub unsafe fn initWithSet( this: Allocated<Self>, set: &NSSet<ObjectType>, ) -> Retained<Self>

Available on crate feature NSSet only.

pub unsafe fn initWithSet_copyItems( this: Allocated<Self>, set: &NSSet<ObjectType>, flag: bool, ) -> Retained<Self>

Available on crate feature NSSet only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSOrderedSetDiffing.

pub unsafe fn differenceFromOrderedSet_withOptions_usingEquivalenceTest( &self, other: &NSOrderedSet<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, block: &Block<dyn Fn(NonNull<ObjectType>, NonNull<ObjectType>) -> Bool + '_>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate features NSOrderedCollectionDifference and block2 only.

pub unsafe fn differenceFromOrderedSet_withOptions( &self, other: &NSOrderedSet<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate feature NSOrderedCollectionDifference only.

pub unsafe fn differenceFromOrderedSet( &self, other: &NSOrderedSet<ObjectType>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate feature NSOrderedCollectionDifference only.

pub unsafe fn orderedSetByApplyingDifference( &self, difference: &NSOrderedCollectionDifference<ObjectType>, ) -> Option<Retained<NSOrderedSet<ObjectType>>>

Available on crate feature NSOrderedCollectionDifference only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSPredicateSupport.

pub unsafe fn filteredOrderedSetUsingPredicate( &self, p: &NSPredicate, ) -> Retained<NSOrderedSet<ObjectType>>

Available on crate feature NSPredicate only.

impl<ObjectType: Message> NSOrderedSet<ObjectType>

NSKeyValueSorting.

pub unsafe fn sortedArrayUsingDescriptors( &self, sort_descriptors: &NSArray<NSSortDescriptor>, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSSortDescriptor and NSArray 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.

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

fn as_ref(&self) -> &AnyObject

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

impl<ObjectType: ?Sized + Message> AsRef<NSObject> for NSOrderedSet<ObjectType>

fn as_ref(&self) -> &NSObject

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

impl<ObjectType: ?Sized + Message> AsRef<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>

fn as_ref(&self) -> &NSOrderedSet<ObjectType>

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

impl<ObjectType: ?Sized + Message> AsRef<NSOrderedSet<ObjectType>> for NSOrderedSet<ObjectType>

fn as_ref(&self) -> &Self

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

impl<ObjectType: ?Sized + Message> Borrow<AnyObject> for NSOrderedSet<ObjectType>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<ObjectType: ?Sized + Message> Borrow<NSObject> for NSOrderedSet<ObjectType>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<ObjectType: ?Sized + Message> Borrow<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>

fn borrow(&self) -> &NSOrderedSet<ObjectType>

Immutably borrows from an owned value.

impl<ObjectType: ?Sized + Message> ClassType for NSOrderedSet<ObjectType>

const NAME: &'static str = "NSOrderedSet"

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

type Super = NSObject

The superclass of this class.

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

Available on crate feature NSObject only.

type Result = NSOrderedSet<ObjectType>

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

impl<ObjectType: ?Sized> Debug for NSOrderedSet<ObjectType>

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

Formats the value using the given formatter.

impl<ObjectType: ?Sized + Message> Deref for NSOrderedSet<ObjectType>

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl<ObjectType: ?Sized> Hash for NSOrderedSet<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<ObjectType: ?Sized + Message> Message for NSOrderedSet<ObjectType>

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

where Self: Sized,

Increment the reference count of the receiver.

impl<ObjectType: ?Sized + Message> MutableCopyingHelper for NSOrderedSet<ObjectType>

Available on crate feature NSObject only.

type Result = NSMutableOrderedSet<ObjectType>

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

impl<ObjectType: ?Sized + NSCoding> NSCoding for NSOrderedSet<ObjectType>

Available on crate feature NSObject only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl<ObjectType: ?Sized> NSCopying for NSOrderedSet<ObjectType>

Available on crate feature NSObject only.

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

where Self: Sized + Message + CopyingHelper,

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,

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

impl<ObjectType: ?Sized> NSFastEnumeration for NSOrderedSet<ObjectType>

Available on crate feature NSEnumerator only.

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

where Self: Sized + Message,

impl<ObjectType: ?Sized> NSMutableCopying for NSOrderedSet<ObjectType>

Available on crate feature NSObject only.

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

where Self: Sized + Message + MutableCopyingHelper,

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

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

where Self: Sized + Message + MutableCopyingHelper,

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

impl<ObjectType: ?Sized> NSObjectProtocol for NSOrderedSet<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<ObjectType: ?Sized + NSSecureCoding> NSSecureCoding for NSOrderedSet<ObjectType>

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl<ObjectType: ?Sized> PartialEq for NSOrderedSet<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<ObjectType: ?Sized + Message> RefEncode for NSOrderedSet<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 NSOrderedSet<AnyObject>

impl<ObjectType: ?Sized> Eq for NSOrderedSet<ObjectType>