Struct objc2_foundation::NSSet

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

Available on crate feature NSSet only.

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 unsafe 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 unsafe fn allObjects(&self) -> Retained<NSArray<ObjectType>>

Available on crate feature NSArray only.

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

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

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

pub unsafe 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: &Block<dyn Fn(NonNull<ObjectType>, NonNull<Bool>) + '_> )

Available on crate feature block2 only.

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

Available on crate features NSObjCRuntime and block2 only.

pub unsafe fn objectsPassingTest( &self, predicate: &Block<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: &Block<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<T: Message> NSSet<T>

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

use objc2_foundation::{NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_id_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, NSString};

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

impl<T: Message + Eq + Hash> NSSet<T>

pub fn from_vec(vec: Vec<Retained<T>>) -> Retained<Self>

where T: HasStableHash,

Creates an NSSet from a vector.

Examples

use objc2_foundation::{NSSet, NSString};

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

pub fn from_id_slice(slice: &[Retained<T>]) -> Retained<Self>

where T: HasStableHash + IsIdCloneable,

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_id_slice(&strs);

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

where T: HasStableHash + IsRetainable,

pub fn to_vec(&self) -> Vec<&T>

Available on crate feature NSEnumerator only.

Returns a Vec containing the set’s elements.

Examples

use objc2_foundation::{NSMutableString, NSSet};

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

pub fn to_vec_retained(&self) -> Vec<Retained<T>>

where T: IsIdCloneable,

Available on crate feature NSEnumerator only.

pub fn to_array(&self) -> Retained<NSArray<T>>

where T: IsIdCloneable,

Available on crate feature NSArray only.

Returns an NSArray containing the set’s elements, or an empty array if the set is empty.

Examples

use objc2_foundation::{NSNumber, NSSet, NSString};

let nums = [1, 2, 3];
let set = NSSet::from_id_slice(&nums.map(NSNumber::new_i32));

assert_eq!(set.to_array().len(), 3);
assert!(set.to_array().iter().all(|i| nums.contains(&i.as_i32())));

impl<T: Message> NSSet<T>

pub fn get_any(&self) -> Option<&T>

Returns a reference to one of the objects in the set, or None if the set is empty.

Examples

use objc2_foundation::{NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_id_slice(&strs);
let any = set.get_any().unwrap();
assert!(any == &*strs[0] || any == &*strs[1] || any == &*strs[2]);

impl<T: Message + Eq + Hash> NSSet<T>

pub fn contains(&self, value: &T) -> bool

Returns true if the set contains a value.

Examples

use objc2_foundation::{ns_string, NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_id_slice(&strs);
assert!(set.contains(ns_string!("one")));

pub fn get(&self, value: &T) -> Option<&T>

Returns a reference to the value in the set, if any, that is equal to the given value.

Examples

use objc2_foundation::{ns_string, NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_id_slice(&strs);
assert_eq!(set.get(ns_string!("one")), Some(&*strs[0]));
assert_eq!(set.get(ns_string!("four")), None);

pub fn get_retained(&self, value: &T) -> Option<Retained<T>>

where T: IsIdCloneable,

pub fn is_subset(&self, other: &NSSet<T>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the values in self.

Examples

use objc2_foundation::{NSSet, NSString};

let set1 = NSSet::from_id_slice(&["one", "two"].map(NSString::from_str));
let set2 = NSSet::from_id_slice(&["one", "two", "three"].map(NSString::from_str));

assert!(set1.is_subset(&set2));
assert!(!set2.is_subset(&set1));

pub fn is_superset(&self, other: &NSSet<T>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the values in other.

Examples

use objc2_foundation::{NSSet, NSString};

let set1 = NSSet::from_id_slice(&["one", "two"].map(NSString::from_str));
let set2 = NSSet::from_id_slice(&["one", "two", "three"].map(NSString::from_str));

assert!(!set1.is_superset(&set2));
assert!(set2.is_superset(&set1));

pub fn is_disjoint(&self, other: &NSSet<T>) -> bool

Returns true if self has no elements in common with other.

Examples

use objc2_foundation::{NSSet, NSString};

let set1 = NSSet::from_id_slice(&["one", "two"].map(NSString::from_str));
let set2 = NSSet::from_id_slice(&["one", "two", "three"].map(NSString::from_str));
let set3 = NSSet::from_id_slice(&["four", "five", "six"].map(NSString::from_str));

assert!(!set1.is_disjoint(&set2));
assert!(set1.is_disjoint(&set3));
assert!(set2.is_disjoint(&set3));

impl<T: Message> NSSet<T>

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

Available on crate feature NSEnumerator only.

An iterator visiting all elements in arbitrary order.

Examples

use objc2_foundation::{NSSet, NSString};

let strs = ["one", "two", "three"].map(NSString::from_str);
let set = NSSet::from_id_slice(&strs);
for s in &set {
    println!("{s}");
}

pub fn iter_retained(&self) -> IterRetained<'_, T>

where T: IsIdCloneable,

Available on crate feature NSEnumerator 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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

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

fn as_mut(&mut self) -> &mut AnyObject

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

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

fn as_mut(&mut self) -> &mut NSObject

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

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

fn as_mut(&mut self) -> &mut NSSet<ObjectType>

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

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

fn as_mut(&mut self) -> &mut NSSet<ObjectType>

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

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

fn as_mut(&mut self) -> &mut Self

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

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> BorrowMut<AnyObject> for NSSet<ObjectType>

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

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

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

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

fn borrow_mut(&mut self) -> &mut NSSet<ObjectType>

Mutably borrows from an owned value.

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

fn borrow_mut(&mut self) -> &mut NSSet<ObjectType>

Mutably borrows from an owned value.

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

type Super = NSObject

The superclass of this class.

type Mutability = ImmutableWithMutableSubclass<NSMutableSet<ObjectType>>

Whether the type is mutable or immutable.

const NAME: &'static str = "NSSet"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

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

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_id() -> Retained<Self>

The default Retained for a type.

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 + Message> DerefMut for NSSet<ObjectType>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &NSSet<ObjectType>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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, T: Message + Eq + Hash + HasStableHash + IsRetainable + 'a> RetainedFromIterator<&'a T> for NSSet<T>

fn id_from_iter<I: IntoIterator<Item = &'a T>>(iter: I) -> Retained<Self>

Creates an Retained from an iterator.

fn retained_from_iter<I>(iter: I) -> Retained<Self>

where I: IntoIterator<Item = T>,

Creates an Retained from an iterator.

impl<T: Message + Eq + Hash + HasStableHash> RetainedFromIterator<Retained<T>> for NSSet<T>

fn id_from_iter<I: IntoIterator<Item = Retained<T>>>(iter: I) -> Retained<Self>

Creates an Retained from an iterator.

fn retained_from_iter<I>(iter: I) -> Retained<Self>

where I: IntoIterator<Item = T>,

Creates an Retained from an iterator.

impl<T: Message + IsIdCloneable> RetainedIntoIterator for NSSet<T>

type Item = Retained<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

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

Creates an iterator from an Retained.

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

Creates an iterator from an Retained.

impl<T: Message + IsIdCloneable> ToOwned for NSSet<T>

Available on crate feature NSObject only.

type Owned = Retained<NSSet<T>>

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<ObjectType: Eq + ?Sized> Eq for NSSet<ObjectType>

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

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

Available on crate feature NSObject only.

impl<ObjectType: ?Sized + IsIdCloneable> NSCopying for NSSet<ObjectType>

Available on crate feature NSObject only.

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

Available on crate feature NSEnumerator only.

impl<ObjectType: ?Sized + IsIdCloneable> NSMutableCopying for NSSet<ObjectType>

Available on crate feature NSObject only.

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

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

Available on crate feature NSObject only.

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