Struct objc2::foundation::NSMutableSet

#[repr(C)]
pub struct NSMutableSet<T: Message, O: Ownership = Owned> { /* private fields */ }

A growable unordered collection of unique objects.

See the documentation for NSSet and/or Apple’s documentation for more information.

Implementations

impl<T: Message, O: Ownership> NSMutableSet<T, O>

pub fn new() -> Id<Self, Owned>

Creates an empty NSMutableSet.

Examples

use objc2::foundation::{NSMutableSet, NSString};

let set = NSMutableSet::<NSString>::new();

pub fn from_vec(vec: Vec<Id<T, O>>) -> Id<Self, Owned>

Creates an NSMutableSet from a vector.

Examples

use objc2::foundation::{NSMutableSet, NSString};

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

pub fn clear(&mut self)

Clears the set, removing all values.

Examples

use objc2::foundation::{NSMutableSet, NSString};

let mut set = NSMutableSet::new();
set.insert(NSString::from_str("one"));
set.clear();
assert!(set.is_empty());

pub fn into_vec(set: Id<Self, Owned>) -> Vec<Id<T, O>>

Returns a Vec containing the set’s elements, consuming the set.

Examples

use objc2::foundation::{NSMutableSet, NSMutableString};

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

impl<T: Message> NSMutableSet<T, Shared>

pub fn from_slice(slice: &[Id<T, Shared>]) -> Id<Self, Owned>

Creates an NSMutableSet from a slice.

Examples

use objc2::foundation::{NSMutableSet, NSString};

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

impl<T: Message + PartialEq, O: Ownership> NSMutableSet<T, O>

pub fn insert(&mut self, value: Id<T, O>) -> bool

Adds a value to the set. Returns whether the value was newly inserted.

Examples

use objc2::foundation::{NSMutableSet, NSString};

let mut set = NSMutableSet::new();

assert_eq!(set.insert(NSString::from_str("one")), true);
assert_eq!(set.insert(NSString::from_str("one")), false);
assert_eq!(set.len(), 1);

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

Removes a value from the set. Returns whether the value was present in the set.

Examples

use objc2::foundation::{NSMutableSet, NSString};
use objc2::ns_string;

let mut set = NSMutableSet::new();

set.insert(NSString::from_str("one"));
assert_eq!(set.remove(ns_string!("one")), true);
assert_eq!(set.remove(ns_string!("one")), false);

Methods from Deref<Target = NSSet<T, O>>

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_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());

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_slice(&strs);
let any = set.get_any().unwrap();
assert!(any == &*strs[0] || any == &*strs[1] || any == &*strs[2]);

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

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_slice(&strs);
for s in set.iter() {
    println!("{s}");
}

pub fn to_array(&self) -> Id<NSArray<T, Shared>, Shared>

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_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())));

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

Returns true if the set contains a value.

Examples

use objc2::foundation::{NSSet, NSString};
use objc2::ns_string;

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

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

pub fn is_subset(&self, other: &NSSet<T, O>) -> 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_slice(&["one", "two"].map(NSString::from_str));
let set2 = NSSet::from_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, O>) -> 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_slice(&["one", "two"].map(NSString::from_str));
let set2 = NSSet::from_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, O>) -> bool

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

Examples

use objc2::foundation::{NSSet, NSString};

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

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

Methods from Deref<Target = NSObject>

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

pub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T

Returns a pointer to the instance variable / ivar with the given name.

This is similar to UnsafeCell::get, see that for more information on what is and isn’t safe to do.

Usually you will have defined the instance variable yourself with ClassBuilder::add_ivar, the type of the ivar T must match the type used in that.

Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.

Library implementors are strongly encouraged to expose a safe interface to the ivar.

Panics

May panic if the object has no ivar with the given name. May also panic if the type encoding of the ivar differs from the type encoding of T.

This should purely seen as help while debugging and is not guaranteed (e.g. it may be disabled when debug_assertions are off).

Safety

The object must have an instance variable with the given name, and it must be of type T. Any invariants that the object have assumed about the value of the instance variable must not be violated.

No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.

pub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T

Returns a reference to the instance variable with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

No thread syncronization is done, so you must ensure that no other thread is concurrently mutating the variable. This requirement can be considered upheld if all mutation happens through Object::ivar_mut (since that takes &mut self).

pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

pub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T

Returns a mutable reference to the ivar with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

This access happens through &mut self, which means we know it to be the only reference, hence you do not need to do any work to ensure that data races do not happen.

pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated: Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

pub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)

Sets the value of the ivar with the given name.

This is just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations

impl<T: Message, O: Ownership> AsMut<NSMutableSet<T, O>> for NSMutableSet<T, O>

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

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

impl<T: Message, O: Ownership> AsMut<NSObject> for NSMutableSet<T, O>

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

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

impl<T: Message, O: Ownership> AsMut<NSSet<T, O>> for NSMutableSet<T, O>

fn as_mut(&mut self) -> &mut NSSet<T, O>

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

impl<T: Message, O: Ownership> AsMut<Object> for NSMutableSet<T, O>

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

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

impl<T: Message, O: Ownership> AsRef<NSMutableSet<T, O>> for NSMutableSet<T, O>

fn as_ref(&self) -> &Self

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

impl<T: Message, O: Ownership> AsRef<NSObject> for NSMutableSet<T, O>

fn as_ref(&self) -> &NSObject

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

impl<T: Message, O: Ownership> AsRef<NSSet<T, O>> for NSMutableSet<T, O>

fn as_ref(&self) -> &NSSet<T, O>

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

impl<T: Message, O: Ownership> AsRef<Object> for NSMutableSet<T, O>

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> Borrow<NSObject> for NSMutableSet<T, O>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<NSSet<T, O>> for NSMutableSet<T, O>

fn borrow(&self) -> &NSSet<T, O>

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<Object> for NSMutableSet<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<NSObject> for NSMutableSet<T, O>

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<NSSet<T, O>> for NSMutableSet<T, O>

fn borrow_mut(&mut self) -> &mut NSSet<T, O>

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableSet<T, O>

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> ClassType for NSMutableSet<T, O>

type Super = NSSet<T, O>

The superclass of this class.

const NAME: &'static str = _

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

fn class() -> &'static Class

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.

impl<T: Debug + Message, O: Ownership> Debug for NSMutableSet<T, O>

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

Formats the value using the given formatter.

impl<T: Message, O: Ownership> DefaultId for NSMutableSet<T, O>

type Ownership = Owned

Indicates whether the default value is mutable or immutable.

fn default_id() -> Id<Self, Self::Ownership>

The default Id for a type.

impl<T: Message, O: Ownership> Deref for NSMutableSet<T, O>

type Target = NSSet<T, O>

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Message, O: Ownership> DerefMut for NSMutableSet<T, O>

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

Mutably dereferences the value.

impl<T: Message + PartialEq, O: Ownership> Extend<Id<T, O>> for NSMutableSet<T, O>

fn extend<I: IntoIterator<Item = Id<T, O>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Hash + Message, O: Hash + Ownership> Hash for NSMutableSet<T, O>

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, O: Ownership> IntoIterator for &'a NSMutableSet<T, O>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = NSFastEnumerator<'a, NSMutableSet<T, O>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Message> NSCopying for NSMutableSet<T, Shared>

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSSet<T, Shared>

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl<T: Message, O: Ownership> NSFastEnumeration for NSMutableSet<T, O>

type Item = T

fn iter_fast(&self) -> NSFastEnumerator<'_, Self>

impl<T: Message> NSMutableCopying for NSMutableSet<T, Shared>

type Output = NSMutableSet<T, Shared>

TODO

fn mutable_copy(&self) -> Id<Self::Output, Owned>

impl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSMutableSet<T, O>> for NSMutableSet<T, O>

fn eq(&self, other: &NSMutableSet<T, O>) -> 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<T: Message, O: Ownership> RefEncode for NSMutableSet<T, O>

const ENCODING_REF: Encoding = <NSSet<T, O> as crate::RefEncode>::ENCODING_REF

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

impl<T: Message> ToOwned for NSMutableSet<T, Shared>

type Owned = Id<NSMutableSet<T, Shared>, Owned>

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<T: Eq + Message, O: Eq + Ownership> Eq for NSMutableSet<T, O>

impl<T: Message, O: Ownership> Message for NSMutableSet<T, O>

impl<T: Message + Send> Send for NSMutableSet<T, Owned>

impl<T: Message + Sync + Send> Send for NSMutableSet<T, Shared>

impl<T: Message, O: Ownership> StructuralEq for NSMutableSet<T, O>

impl<T: Message, O: Ownership> StructuralPartialEq for NSMutableSet<T, O>

impl<T: Message + Sync> Sync for NSMutableSet<T, Owned>

impl<T: Message + Sync + Send> Sync for NSMutableSet<T, Shared>