Struct objc2::foundation::NSMutableSet

source · [−]
#[repr(C)]
pub struct NSMutableSet<T: Message, O: Ownership = Owned> { /* private fields */ }
Available on crate feature foundation only.
Expand description

A growable unordered collection of unique objects.

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

Implementations

Creates an empty NSMutableSet.

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

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

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

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

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

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

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

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>>

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

Returns true if the set contains no elements.

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

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

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]);

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}");
}

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

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")));

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

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

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

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>

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>

Dynamically find the class of this object.

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.

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).

👎Deprecated:

Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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.

👎Deprecated:

Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

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

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

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

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

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

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

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

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

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

Immutably borrows from an owned value. Read more

Immutably borrows from an owned value. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

The superclass of this class. Read more

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

Get a reference to the Objective-C class that this type represents. Read more

Get an immutable reference to the superclass.

Get a mutable reference to the superclass.

Formats the value using the given formatter. Read more

Indicates whether the default value is mutable or immutable.

The default Id for a type. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Extends a collection with the contents of an iterator. Read more

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

Extends a collection with exactly one element.

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

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

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

Available on crate feature foundation only.

Indicates whether the type is mutable or immutable. Read more

Available on crate feature foundation only.

The output type. Read more

Available on crate feature foundation only.
Available on crate feature foundation only.
Available on crate feature foundation only.
Available on crate feature foundation only.

TODO

Available on crate feature foundation only.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

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

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.