pub struct NSMutableOrderedSet<ObjectType: ?Sized = AnyObject> { /* private fields */ }
NSOrderedSet
only.Expand description
************** Mutable Ordered Set ***************
See also Apple’s documentation
Implementations§
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSOrderedSet
.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSOrderedSet
.
NSOrderedSetCreation.
pub fn orderedSet() -> Retained<Self>
pub fn orderedSetWithObject(object: &ObjectType) -> Retained<Self>
Sourcepub unsafe fn orderedSetWithObjects_count(
objects: NonNull<NonNull<ObjectType>>,
cnt: NSUInteger,
) -> Retained<Self>
pub unsafe fn orderedSetWithObjects_count( objects: NonNull<NonNull<ObjectType>>, cnt: NSUInteger, ) -> Retained<Self>
§Safety
objects
must be a valid pointer.
pub fn orderedSetWithOrderedSet( set: &NSOrderedSet<ObjectType>, ) -> Retained<Self>
pub unsafe fn orderedSetWithOrderedSet_range_copyItems( set: &NSOrderedSet<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>
NSRange
only.pub fn orderedSetWithArray(array: &NSArray<ObjectType>) -> Retained<Self>
NSArray
only.pub unsafe fn orderedSetWithArray_range_copyItems( array: &NSArray<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>
NSArray
and NSRange
only.pub fn orderedSetWithSet(set: &NSSet<ObjectType>) -> Retained<Self>
NSSet
only.pub unsafe fn orderedSetWithSet_copyItems( set: &NSSet<ObjectType>, flag: bool, ) -> Retained<Self>
NSSet
only.pub fn initWithObject( this: Allocated<Self>, object: &ObjectType, ) -> Retained<Self>
pub 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>
NSRange
only.pub fn initWithArray( this: Allocated<Self>, array: &NSArray<ObjectType>, ) -> Retained<Self>
NSArray
only.pub unsafe fn initWithArray_copyItems( this: Allocated<Self>, set: &NSArray<ObjectType>, flag: bool, ) -> Retained<Self>
NSArray
only.pub unsafe fn initWithArray_range_copyItems( this: Allocated<Self>, set: &NSArray<ObjectType>, range: NSRange, flag: bool, ) -> Retained<Self>
NSArray
and NSRange
only.pub fn initWithSet( this: Allocated<Self>, set: &NSSet<ObjectType>, ) -> Retained<Self>
NSSet
only.pub unsafe fn initWithSet_copyItems( this: Allocated<Self>, set: &NSSet<ObjectType>, flag: bool, ) -> Retained<Self>
NSSet
only.Source§impl<ObjectType: ?Sized + Message> NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + Message> NSMutableOrderedSet<ObjectType>
Sourcepub unsafe fn cast_unchecked<NewObjectType: ?Sized + Message>(
&self,
) -> &NSMutableOrderedSet<NewObjectType>
pub unsafe fn cast_unchecked<NewObjectType: ?Sized + Message>( &self, ) -> &NSMutableOrderedSet<NewObjectType>
Unchecked conversion of the generic parameter.
§Safety
The generic must be valid to reinterpret as the given type.
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
pub fn insertObject_atIndex(&self, object: &ObjectType, idx: NSUInteger)
pub fn removeObjectAtIndex(&self, idx: NSUInteger)
pub fn replaceObjectAtIndex_withObject( &self, idx: NSUInteger, object: &ObjectType, )
Sourcepub unsafe fn initWithCoder(
this: Allocated<Self>,
coder: &NSCoder,
) -> Option<Retained<Self>>
Available on crate feature NSCoder
only.
pub unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
NSCoder
only.§Safety
coder
possibly has further requirements.
pub fn init(this: Allocated<Self>) -> Retained<Self>
pub fn initWithCapacity( this: Allocated<Self>, num_items: NSUInteger, ) -> Retained<Self>
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSOrderedSet
.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSOrderedSet
.
Sourcepub unsafe fn initWithObjects_count(
this: Allocated<Self>,
objects: *mut NonNull<ObjectType>,
cnt: NSUInteger,
) -> Retained<Self>
pub unsafe fn initWithObjects_count( this: Allocated<Self>, objects: *mut NonNull<ObjectType>, cnt: NSUInteger, ) -> Retained<Self>
§Safety
objects
must be a valid pointer or null.
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSObject
.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
Methods declared on superclass NSObject
.
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSExtendedMutableOrderedSet.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSExtendedMutableOrderedSet.
pub fn addObject(&self, object: &ObjectType)
Sourcepub unsafe fn addObjects_count(
&self,
objects: *mut NonNull<ObjectType>,
count: NSUInteger,
)
pub unsafe fn addObjects_count( &self, objects: *mut NonNull<ObjectType>, count: NSUInteger, )
§Safety
objects
must be a valid pointer or null.
pub fn addObjectsFromArray(&self, array: &NSArray<ObjectType>)
NSArray
only.pub fn exchangeObjectAtIndex_withObjectAtIndex( &self, idx1: NSUInteger, idx2: NSUInteger, )
pub fn moveObjectsAtIndexes_toIndex( &self, indexes: &NSIndexSet, idx: NSUInteger, )
NSIndexSet
only.pub fn insertObjects_atIndexes( &self, objects: &NSArray<ObjectType>, indexes: &NSIndexSet, )
NSArray
and NSIndexSet
only.pub fn setObject_atIndex(&self, obj: &ObjectType, idx: NSUInteger)
pub fn setObject_atIndexedSubscript(&self, obj: &ObjectType, idx: NSUInteger)
Sourcepub unsafe fn replaceObjectsInRange_withObjects_count(
&self,
range: NSRange,
objects: *mut NonNull<ObjectType>,
count: NSUInteger,
)
Available on crate feature NSRange
only.
pub unsafe fn replaceObjectsInRange_withObjects_count( &self, range: NSRange, objects: *mut NonNull<ObjectType>, count: NSUInteger, )
NSRange
only.§Safety
objects
must be a valid pointer or null.
pub fn replaceObjectsAtIndexes_withObjects( &self, indexes: &NSIndexSet, objects: &NSArray<ObjectType>, )
NSArray
and NSIndexSet
only.pub fn removeObjectsInRange(&self, range: NSRange)
NSRange
only.pub fn removeObjectsAtIndexes(&self, indexes: &NSIndexSet)
NSIndexSet
only.pub fn removeAllObjects(&self)
pub fn removeObject(&self, object: &ObjectType)
pub fn removeObjectsInArray(&self, array: &NSArray<ObjectType>)
NSArray
only.pub fn intersectOrderedSet(&self, other: &NSOrderedSet<ObjectType>)
pub fn minusOrderedSet(&self, other: &NSOrderedSet<ObjectType>)
pub fn unionOrderedSet(&self, other: &NSOrderedSet<ObjectType>)
pub fn intersectSet(&self, other: &NSSet<ObjectType>)
NSSet
only.pub fn minusSet(&self, other: &NSSet<ObjectType>)
NSSet
only.pub fn unionSet(&self, other: &NSSet<ObjectType>)
NSSet
only.Sourcepub unsafe fn sortUsingComparator(&self, cmptr: NSComparator)
Available on crate features NSObjCRuntime
and block2
only.
pub unsafe fn sortUsingComparator(&self, cmptr: NSComparator)
NSObjCRuntime
and block2
only.§Safety
cmptr
must be a valid pointer.
Sourcepub unsafe fn sortWithOptions_usingComparator(
&self,
opts: NSSortOptions,
cmptr: NSComparator,
)
Available on crate features NSObjCRuntime
and block2
only.
pub unsafe fn sortWithOptions_usingComparator( &self, opts: NSSortOptions, cmptr: NSComparator, )
NSObjCRuntime
and block2
only.§Safety
cmptr
must be a valid pointer.
Sourcepub unsafe fn sortRange_options_usingComparator(
&self,
range: NSRange,
opts: NSSortOptions,
cmptr: NSComparator,
)
Available on crate features NSObjCRuntime
and NSRange
and block2
only.
pub unsafe fn sortRange_options_usingComparator( &self, range: NSRange, opts: NSSortOptions, cmptr: NSComparator, )
NSObjCRuntime
and NSRange
and block2
only.§Safety
cmptr
must be a valid pointer.
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSMutableOrderedSetCreation.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSMutableOrderedSetCreation.
pub fn orderedSetWithCapacity(num_items: NSUInteger) -> Retained<Self>
Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSMutableOrderedSetDiffing.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSMutableOrderedSetDiffing.
pub fn applyDifference( &self, difference: &NSOrderedCollectionDifference<ObjectType>, )
NSOrderedCollectionDifference
only.Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSPredicateSupport.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSPredicateSupport.
pub fn filterUsingPredicate(&self, p: &NSPredicate)
NSPredicate
only.Source§impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSKeyValueSorting.
impl<ObjectType: Message> NSMutableOrderedSet<ObjectType>
NSKeyValueSorting.
pub fn sortUsingDescriptors(&self, sort_descriptors: &NSArray<NSSortDescriptor>)
NSSortDescriptor
and NSArray
only.Methods from Deref<Target = NSOrderedSet<ObjectType>>§
pub fn valueForKey(&self, key: &NSString) -> Retained<AnyObject>
NSKeyValueCoding
and NSString
only.Sourcepub unsafe fn setValue_forKey(&self, value: Option<&AnyObject>, key: &NSString)
Available on crate features NSKeyValueCoding
and NSString
only.
pub unsafe fn setValue_forKey(&self, value: Option<&AnyObject>, key: &NSString)
NSKeyValueCoding
and NSString
only.§Safety
value
should be of the correct type.
Sourcepub 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 addObserver_forKeyPath_options_context( &self, observer: &NSObject, key_path: &NSString, options: NSKeyValueObservingOptions, context: *mut c_void, )
NSKeyValueObserving
and NSString
only.§Safety
observer
should be of the correct type.context
must be a valid pointer or null.
Sourcepub 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_context( &self, observer: &NSObject, key_path: &NSString, context: *mut c_void, )
NSKeyValueObserving
and NSString
only.§Safety
observer
should be of the correct type.context
must be a valid pointer or null.
Sourcepub unsafe fn removeObserver_forKeyPath(
&self,
observer: &NSObject,
key_path: &NSString,
)
Available on crate features NSKeyValueObserving
and NSString
only.
pub unsafe fn removeObserver_forKeyPath( &self, observer: &NSObject, key_path: &NSString, )
NSKeyValueObserving
and NSString
only.§Safety
observer
should be of the correct type.
Sourcepub unsafe fn cast_unchecked<NewObjectType: ?Sized + Message>(
&self,
) -> &NSOrderedSet<NewObjectType>
pub unsafe fn cast_unchecked<NewObjectType: ?Sized + Message>( &self, ) -> &NSOrderedSet<NewObjectType>
Unchecked conversion of the generic parameter.
§Safety
The generic must be valid to reinterpret as the given type.
pub fn count(&self) -> NSUInteger
pub fn objectAtIndex(&self, idx: NSUInteger) -> Retained<ObjectType>
pub fn indexOfObject(&self, object: &ObjectType) -> NSUInteger
Sourcepub unsafe fn getObjects_range(
&self,
objects: *mut NonNull<ObjectType>,
range: NSRange,
)
Available on crate feature NSRange
only.
pub unsafe fn getObjects_range( &self, objects: *mut NonNull<ObjectType>, range: NSRange, )
NSRange
only.§Safety
objects
must be a valid pointer or null.
pub fn objectsAtIndexes( &self, indexes: &NSIndexSet, ) -> Retained<NSArray<ObjectType>>
NSArray
and NSIndexSet
only.pub fn firstObject(&self) -> Option<Retained<ObjectType>>
pub fn lastObject(&self) -> Option<Retained<ObjectType>>
pub fn isEqualToOrderedSet(&self, other: &NSOrderedSet<ObjectType>) -> bool
pub fn containsObject(&self, object: &ObjectType) -> bool
pub fn intersectsOrderedSet(&self, other: &NSOrderedSet<ObjectType>) -> bool
pub fn intersectsSet(&self, set: &NSSet<ObjectType>) -> bool
NSSet
only.pub fn isSubsetOfOrderedSet(&self, other: &NSOrderedSet<ObjectType>) -> bool
pub fn isSubsetOfSet(&self, set: &NSSet<ObjectType>) -> bool
NSSet
only.pub fn objectAtIndexedSubscript(&self, idx: NSUInteger) -> Retained<ObjectType>
Sourcepub unsafe fn objectEnumerator(&self) -> Retained<NSEnumerator<ObjectType>>
Available on crate feature NSEnumerator
only.
pub unsafe fn objectEnumerator(&self) -> Retained<NSEnumerator<ObjectType>>
NSEnumerator
only.§Safety
The returned enumerator’s underlying collection should not be mutated while in use.
Sourcepub unsafe fn reverseObjectEnumerator(
&self,
) -> Retained<NSEnumerator<ObjectType>>
Available on crate feature NSEnumerator
only.
pub unsafe fn reverseObjectEnumerator( &self, ) -> Retained<NSEnumerator<ObjectType>>
NSEnumerator
only.§Safety
The returned enumerator’s underlying collection should not be mutated while in use.
pub fn reversedOrderedSet(&self) -> Retained<NSOrderedSet<ObjectType>>
pub fn array(&self) -> Retained<NSArray<ObjectType>>
NSArray
only.pub fn set(&self) -> Retained<NSSet<ObjectType>>
NSSet
only.pub fn enumerateObjectsUsingBlock( &self, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )
block2
only.pub fn enumerateObjectsWithOptions_usingBlock( &self, opts: NSEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )
NSObjCRuntime
and block2
only.pub fn enumerateObjectsAtIndexes_options_usingBlock( &self, s: &NSIndexSet, opts: NSEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )
NSIndexSet
and NSObjCRuntime
and block2
only.pub fn indexOfObjectPassingTest( &self, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger
block2
only.pub fn indexOfObjectWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger
NSObjCRuntime
and block2
only.pub fn indexOfObjectAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger
NSIndexSet
and NSObjCRuntime
and block2
only.pub fn indexesOfObjectsPassingTest( &self, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>
NSIndexSet
and block2
only.pub fn indexesOfObjectsWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>
NSIndexSet
and NSObjCRuntime
and block2
only.pub fn indexesOfObjectsAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>
NSIndexSet
and NSObjCRuntime
and block2
only.Sourcepub 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 indexOfObject_inSortedRange_options_usingComparator( &self, object: &ObjectType, range: NSRange, opts: NSBinarySearchingOptions, cmp: NSComparator, ) -> NSUInteger
NSArray
and NSObjCRuntime
and NSRange
and block2
only.§Safety
cmp
must be a valid pointer.
Sourcepub unsafe fn sortedArrayUsingComparator(
&self,
cmptr: NSComparator,
) -> Retained<NSArray<ObjectType>>
Available on crate features NSArray
and NSObjCRuntime
and block2
only.
pub unsafe fn sortedArrayUsingComparator( &self, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>
NSArray
and NSObjCRuntime
and block2
only.§Safety
cmptr
must be a valid pointer.
Sourcepub 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 sortedArrayWithOptions_usingComparator( &self, opts: NSSortOptions, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>
NSArray
and NSObjCRuntime
and block2
only.§Safety
cmptr
must be a valid pointer.
pub fn description(&self) -> Retained<NSString>
NSString
only.Sourcepub unsafe fn descriptionWithLocale(
&self,
locale: Option<&AnyObject>,
) -> Retained<NSString>
Available on crate feature NSString
only.
pub unsafe fn descriptionWithLocale( &self, locale: Option<&AnyObject>, ) -> Retained<NSString>
NSString
only.§Safety
locale
should be of the correct type.
Sourcepub unsafe fn descriptionWithLocale_indent(
&self,
locale: Option<&AnyObject>,
level: NSUInteger,
) -> Retained<NSString>
Available on crate feature NSString
only.
pub unsafe fn descriptionWithLocale_indent( &self, locale: Option<&AnyObject>, level: NSUInteger, ) -> Retained<NSString>
NSString
only.§Safety
locale
should be of the correct type.
pub fn differenceFromOrderedSet_withOptions_usingEquivalenceTest( &self, other: &NSOrderedSet<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NonNull<ObjectType>) -> Bool + '_>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>
NSOrderedCollectionDifference
and block2
only.pub fn differenceFromOrderedSet_withOptions( &self, other: &NSOrderedSet<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>
NSOrderedCollectionDifference
only.pub fn differenceFromOrderedSet( &self, other: &NSOrderedSet<ObjectType>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>
NSOrderedCollectionDifference
only.pub fn orderedSetByApplyingDifference( &self, difference: &NSOrderedCollectionDifference<ObjectType>, ) -> Option<Retained<NSOrderedSet<ObjectType>>>
NSOrderedCollectionDifference
only.pub fn filteredOrderedSetUsingPredicate( &self, p: &NSPredicate, ) -> Retained<NSOrderedSet<ObjectType>>
NSPredicate
only.pub fn sortedArrayUsingDescriptors( &self, sort_descriptors: &NSArray<NSSortDescriptor>, ) -> Retained<NSArray<ObjectType>>
NSSortDescriptor
and NSArray
only.Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl<ObjectType: ?Sized + Message> AsRef<NSMutableOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + Message> AsRef<NSMutableOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized + Message> AsRef<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + Message> AsRef<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
Source§fn as_ref(&self) -> &NSOrderedSet<ObjectType>
fn as_ref(&self) -> &NSOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized + Message> Borrow<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + Message> Borrow<NSOrderedSet<ObjectType>> for NSMutableOrderedSet<ObjectType>
Source§fn borrow(&self) -> &NSOrderedSet<ObjectType>
fn borrow(&self) -> &NSOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized + Message> ClassType for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + Message> ClassType for NSMutableOrderedSet<ObjectType>
Source§const NAME: &'static str = "NSMutableOrderedSet"
const NAME: &'static str = "NSMutableOrderedSet"
Source§type Super = NSOrderedSet<ObjectType>
type Super = NSOrderedSet<ObjectType>
Source§type ThreadKind = <<NSMutableOrderedSet<ObjectType> as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSMutableOrderedSet<ObjectType> as ClassType>::Super as ClassType>::ThreadKind
Source§impl<ObjectType: ?Sized + Message> CopyingHelper for NSMutableOrderedSet<ObjectType>
Available on crate feature NSObject
only.
impl<ObjectType: ?Sized + Message> CopyingHelper for NSMutableOrderedSet<ObjectType>
NSObject
only.Source§type Result = NSOrderedSet<ObjectType>
type Result = NSOrderedSet<ObjectType>
Self
if the type has no
immutable counterpart. Read moreSource§impl<ObjectType: ?Sized> Debug for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> Debug for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: Message> DefaultRetained for NSMutableOrderedSet<ObjectType>
impl<ObjectType: Message> DefaultRetained for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized> Hash for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> Hash for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized + Message> MutableCopyingHelper for NSMutableOrderedSet<ObjectType>
Available on crate feature NSObject
only.
impl<ObjectType: ?Sized + Message> MutableCopyingHelper for NSMutableOrderedSet<ObjectType>
NSObject
only.Source§type Result = NSMutableOrderedSet<ObjectType>
type Result = NSMutableOrderedSet<ObjectType>
Self
if the type has no
mutable counterpart. Read moreSource§impl<ObjectType: ?Sized + NSCoding> NSCoding for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized + NSCoding> NSCoding for NSMutableOrderedSet<ObjectType>
Source§unsafe fn encodeWithCoder(&self, coder: &NSCoder)
unsafe fn encodeWithCoder(&self, coder: &NSCoder)
NSObject
and NSCoder
only.Source§impl<ObjectType: ?Sized> NSCopying for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> NSCopying for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized> NSFastEnumeration for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> NSFastEnumeration for NSMutableOrderedSet<ObjectType>
Source§unsafe fn countByEnumeratingWithState_objects_count(
&self,
state: NonNull<NSFastEnumerationState>,
buffer: NonNull<*mut AnyObject>,
len: NSUInteger,
) -> NSUInteger
unsafe fn countByEnumeratingWithState_objects_count( &self, state: NonNull<NSFastEnumerationState>, buffer: NonNull<*mut AnyObject>, len: NSUInteger, ) -> NSUInteger
NSEnumerator
only.Source§impl<ObjectType: ?Sized> NSMutableCopying for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> NSMutableCopying for NSMutableOrderedSet<ObjectType>
Source§impl<ObjectType: ?Sized> NSObjectProtocol for NSMutableOrderedSet<ObjectType>
impl<ObjectType: ?Sized> NSObjectProtocol for NSMutableOrderedSet<ObjectType>
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref