Struct NSSet

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

Available on crate feature NSSet only.

************** Immutable Set ***************

See also Apple’s documentation

Implementations

impl<ObjectType: Message> NSSet<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> NSSet<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> NSSet<ObjectType>

NSPredicateSupport.

pub unsafe fn filteredSetUsingPredicate( &self, predicate: &NSPredicate, ) -> Retained<NSSet<ObjectType>>

Available on crate feature NSPredicate only.

impl<ObjectType: Message> NSSet<ObjectType>

pub fn count(&self) -> NSUInteger

pub fn member(&self, object: &ObjectType) -> Option<Retained<ObjectType>>

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

Available on crate feature NSEnumerator only.

pub 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> NSSet<ObjectType>

Methods declared on superclass NSObject.

pub fn new() -> Retained<Self>

impl<ObjectType: Message> NSSet<ObjectType>

NSExtendedSet.

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

Available on crate feature NSArray only.

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

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

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 fn intersectsSet(&self, other_set: &NSSet<ObjectType>) -> bool

pub unsafe fn isEqualToSet(&self, other_set: &NSSet<ObjectType>) -> bool

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

pub unsafe fn makeObjectsPerformSelector(&self, a_selector: Sel)

pub unsafe fn makeObjectsPerformSelector_withObject( &self, a_selector: Sel, argument: Option<&AnyObject>, )

pub unsafe fn setByAddingObject( &self, an_object: &ObjectType, ) -> Retained<NSSet<ObjectType>>

pub unsafe fn setByAddingObjectsFromSet( &self, other: &NSSet<ObjectType>, ) -> Retained<NSSet<ObjectType>>

pub unsafe fn setByAddingObjectsFromArray( &self, other: &NSArray<ObjectType>, ) -> Retained<NSSet<ObjectType>>

Available on crate feature NSArray only.

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

Available on crate feature block2 only.

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

Available on crate features NSObjCRuntime and block2 only.

pub unsafe fn objectsPassingTest( &self, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSSet<ObjectType>>

Available on crate feature block2 only.

pub unsafe fn objectsWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSSet<ObjectType>>

Available on crate features NSObjCRuntime and block2 only.

impl<ObjectType: Message> NSSet<ObjectType>

NSSetCreation.

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

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

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

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

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

Available on crate feature NSArray only.

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

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

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

Available on crate feature NSArray only.

impl<ObjectType: Message> NSSet<ObjectType>

NSSortDescriptorSorting.

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

Available on crate features NSSortDescriptor and NSArray only.

impl<ObjectType: Message> NSSet<ObjectType>

Convenience creation methods.

pub fn from_retained_slice(slice: &[Retained<ObjectType>]) -> Retained<Self>

Creates an NSSet from a slice of Retaineds.

Examples

use objc2_foundation::{NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_retained_slice(&strs);

pub fn from_slice(slice: &[&ObjectType]) -> Retained<Self>

impl<ObjectType: Message> NSSet<ObjectType>

Direct, unsafe object accessors.

Foundation’s collection types store their items in such a way that they can give out references to their data without having to autorelease it first, see the docs.

This means that we can more efficiently access the set’s objects, but only if the set isn’t mutated via e.g. NSMutableSet methods while doing so - otherwise, we might end up accessing a deallocated object.

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

A direct reference to an arbitrary object in the set.

Consider using the anyObject method instead, unless you’re seeing performance issues from the retaining.

Safety

The set must not be mutated while the reference is live.

pub unsafe fn member_unchecked( &self, object: &ObjectType, ) -> Option<&ObjectType>

A direct reference the member that matches the given object.

Consider using the member method instead, unless you’re seeing performance issues from the retaining.

Safety

The set must not be mutated while the returned reference is live.

pub unsafe fn iter_unchecked(&self) -> IterUnchecked<'_, ObjectType>

Available on crate feature NSEnumerator only.

Iterate over the set in an arbitrary order without retaining the elements.

Consider using the iter method instead, unless you’re seeing performance issues from the retaining.

Safety

The set must not be mutated for the lifetime of the iterator, or the elements it returns.

impl<ObjectType: Message> NSSet<ObjectType>

Various accessor methods.

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

use objc2_foundation::{ns_string, NSSet};

let strs = [ns_string!("one"), ns_string!("two"), ns_string!("three")];
let set = NSSet::from_slice(&strs);
assert_eq!(set.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Examples

use objc2_foundation::{NSSet, NSObject};

let set = NSSet::<NSObject>::new();
assert!(set.is_empty());

pub fn iter(&self) -> Iter<'_, ObjectType>

Available on crate feature NSEnumerator only.

An iterator visiting all elements in arbitrary order.

Examples

use objc2_foundation::{ns_string, NSSet};

let set = NSSet::from_slice(&[ns_string!("one"), ns_string!("two"), ns_string!("three")]);
for s in set.iter() {
    println!("{s}");
}

pub fn to_vec(&self) -> Vec<Retained<ObjectType>>

Available on crate feature NSEnumerator only.

Returns a Vec containing the set’s elements in arbitrary order.

Examples

use objc2_foundation::{NSSet, NSString};

let strs = [
    NSString::from_str("one"),
    NSString::from_str("two"),
    NSString::from_str("three"),
];
let set = NSSet::from_retained_slice(&strs);
let vec = set.to_vec();
assert_eq!(vec.len(), 3);

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

fn as_ref(&self) -> &NSObject

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

impl<ObjectType: ?Sized + Message> AsRef<NSSet<ObjectType>> for NSCountedSet<ObjectType>

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

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

impl<ObjectType: ?Sized + Message> AsRef<NSSet<ObjectType>> for NSMutableSet<ObjectType>

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

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

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

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

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

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<ObjectType: ?Sized + Message> Borrow<NSSet<ObjectType>> for NSCountedSet<ObjectType>

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

Immutably borrows from an owned value.

impl<ObjectType: ?Sized + Message> Borrow<NSSet<ObjectType>> for NSMutableSet<ObjectType>

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

Immutably borrows from an owned value.

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

const NAME: &'static str = "NSSet"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSSet<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 NSSet<ObjectType>

Available on crate feature NSObject only.

type Result = NSSet<ObjectType>

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

impl<ObjectType: Debug + Message> Debug for NSSet<ObjectType>

Available on crate feature NSEnumerator only.

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

Formats the value using the given formatter.

impl<ObjectType: Message> DefaultRetained for NSSet<ObjectType>

fn default_retained() -> Retained<Self>

The default Retained for a type.

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

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl<ObjectType: ?Sized> Hash for NSSet<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<'a, ObjectType: Message> IntoIterator for &'a NSSet<ObjectType>

type Item = Retained<ObjectType>

The type of the elements being iterated over.

type IntoIter = Iter<'a, ObjectType>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<ObjectType: ?Sized + Message> Message for NSSet<ObjectType>

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

where Self: Sized,

Increment the reference count of the receiver.

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

Available on crate feature NSObject only.

type Result = NSMutableSet<ObjectType>

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

impl<ObjectType: ?Sized + NSCoding> NSCoding for NSSet<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<ObjectType: ?Sized> NSCopying for NSSet<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<ObjectType: ?Sized> NSFastEnumeration for NSSet<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<ObjectType: ?Sized> NSMutableCopying for NSSet<ObjectType>

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

where Self: Sized + Message + MutableCopyingHelper,

Available on crate feature NSObject only.

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,

Available on crate feature NSObject only.

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

impl<ObjectType: ?Sized> NSObjectProtocol for NSSet<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 NSSet<ObjectType>

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl<ObjectType: ?Sized> PartialEq for NSSet<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 NSSet<ObjectType>

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

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

impl<'a, ObjectType: Message + 'a> RetainedFromIterator<&'a ObjectType> for NSSet<ObjectType>

fn retained_from_iter<I: IntoIterator<Item = &'a ObjectType>>( iter: I, ) -> Retained<Self>

Creates an Retained from an iterator.

impl<ObjectType: Message> RetainedFromIterator<Retained<ObjectType>> for NSSet<ObjectType>

fn retained_from_iter<I: IntoIterator<Item = Retained<ObjectType>>>( iter: I, ) -> Retained<Self>

Creates an Retained from an iterator.

impl<ObjectType: Message> RetainedIntoIterator for NSSet<ObjectType>

type Item = Retained<ObjectType>

The type of the elements being iterated over.

type IntoIter = IntoIter<ObjectType>

Which kind of iterator are we turning this into?

fn retained_into_iter(this: Retained<Self>) -> Self::IntoIter

Creates an iterator from an Retained.

impl<ObjectType: Message> ToOwned for NSSet<ObjectType>

Available on crate feature NSObject only.

type Owned = Retained<NSSet<ObjectType>>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl DowncastTarget for NSSet<AnyObject>

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