Struct objc2::foundation::NSSet
source · [−]foundation
only.Expand description
An immutable unordered collection of unique objects.
Implementations
sourceimpl<T: Message, O: Ownership> NSSet<T, O>
impl<T: Message, O: Ownership> NSSet<T, O>
sourcepub fn new() -> Id<Self, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn new() -> Id<Self, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourcepub fn from_vec(vec: Vec<Id<T, O>>) -> Id<Self, O>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn from_vec(vec: Vec<Id<T, O>>) -> Id<Self, O>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourcepub fn len(&self) -> usize
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);
sourcepub fn is_empty(&self) -> bool
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());
sourcepub fn get_any(&self) -> Option<&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_slice(&strs);
let any = set.get_any().unwrap();
assert!(any == &*strs[0] || any == &*strs[1] || any == &*strs[2]);
sourcepub fn iter(&self) -> NSEnumerator<'_, T>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn iter(&self) -> NSEnumerator<'_, T>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a 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}");
}
sourcepub fn into_vec(set: Id<Self, O>) -> Vec<Id<T, O>>
pub fn into_vec(set: Id<Self, O>) -> Vec<Id<T, O>>
Returns a Vec
containing the set’s elements, consuming the set.
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 = NSSet::into_vec(set);
assert_eq!(vec.len(), 3);
sourcepub fn from_slice(slice: &[Id<T, Shared>]) -> Id<Self, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn from_slice(slice: &[Id<T, Shared>]) -> Id<Self, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourcepub fn to_array(&self) -> Id<NSArray<T, Shared>, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn to_array(&self) -> Id<NSArray<T, Shared>, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
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())));
sourceimpl<T: Message + PartialEq, O: Ownership> NSSet<T, O>
impl<T: Message + PartialEq, O: Ownership> NSSet<T, O>
sourcepub fn contains(&self, value: &T) -> bool
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")));
sourcepub fn get(&self, value: &T) -> Option<&T>
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);
sourcepub fn is_subset(&self, other: &NSSet<T, O>) -> bool
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));
sourcepub fn is_superset(&self, other: &NSSet<T, O>) -> bool
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));
sourcepub fn is_disjoint(&self, other: &NSSet<T, O>) -> bool
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>
sourcepub fn is_kind_of<T: ClassType>(&self) -> bool
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>
sourcepub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T
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.
sourcepub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T
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
).
sourcepub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
👎Deprecated: Use Object::ivar
instead.
pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
Use Object::ivar
instead.
sourcepub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T
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.
sourcepub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
👎Deprecated: Use Object::ivar_mut
instead.
pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
Use Object::ivar_mut
instead.
sourcepub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)
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
sourceimpl<T: Message, O: Ownership> BorrowMut<NSObject> for NSSet<T, O>
impl<T: Message, O: Ownership> BorrowMut<NSObject> for NSSet<T, O>
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<NSSet<T, O>> for NSMutableSet<T, O>
impl<T: Message, O: Ownership> BorrowMut<NSSet<T, O>> for NSMutableSet<T, O>
sourcefn borrow_mut(&mut self) -> &mut NSSet<T, O>
fn borrow_mut(&mut self) -> &mut NSSet<T, O>
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSSet<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSSet<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> ClassType for NSSet<T, O>
impl<T: Message, O: Ownership> ClassType for NSSet<T, O>
sourceimpl<T: Message, O: Ownership> DefaultId for NSSet<T, O>
impl<T: Message, O: Ownership> DefaultId for NSSet<T, O>
sourcefn default_id() -> Id<Self, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn default_id() -> Id<Self, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourceimpl<'a, T: Message, O: Ownership> IntoIterator for &'a NSSet<T, O>
impl<'a, T: Message, O: Ownership> IntoIterator for &'a NSSet<T, O>
type Ownership = Shared
type Ownership = Shared
foundation
only.Indicates whether the type is mutable or immutable. Read more
sourcefn copy(&self) -> Id<Self::Output, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn copy(&self) -> Id<Self::Output, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
foundation
only.sourceimpl<T: Message, O: Ownership> NSFastEnumeration for NSSet<T, O>
impl<T: Message, O: Ownership> NSFastEnumeration for NSSet<T, O>
type Item = T
type Item = T
foundation
only.sourcefn iter_fast(&self) -> NSFastEnumerator<'_, Self>ⓘNotable traits for NSFastEnumerator<'a, C>impl<'a, C: NSFastEnumeration + ?Sized> Iterator for NSFastEnumerator<'a, C> type Item = &'a C::Item;
fn iter_fast(&self) -> NSFastEnumerator<'_, Self>ⓘNotable traits for NSFastEnumerator<'a, C>impl<'a, C: NSFastEnumeration + ?Sized> Iterator for NSFastEnumerator<'a, C> type Item = &'a C::Item;
foundation
only.sourcefn mutable_copy(&self) -> Id<Self::Output, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn mutable_copy(&self) -> Id<Self::Output, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
foundation
only.sourceimpl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSSet<T, O>> for NSSet<T, O>
impl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSSet<T, O>> for NSSet<T, O>
sourceimpl<T: Message, O: Ownership> RefEncode for NSSet<T, O>
impl<T: Message, O: Ownership> RefEncode for NSSet<T, O>
sourceconst ENCODING_REF: Encoding = <NSObject as crate::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSObject as crate::RefEncode>::ENCODING_REF
The Objective-C type-encoding for a reference of this type. Read more
impl<T: Eq + Message, O: Eq + Ownership> Eq for NSSet<T, O>
impl<T: Message, O: Ownership> Message for NSSet<T, O>
impl<T: Message + RefUnwindSafe, O: Ownership> RefUnwindSafe for NSSet<T, O>
impl<T: Message + Send> Send for NSSet<T, Owned>
impl<T: Message, O: Ownership> StructuralEq for NSSet<T, O>
impl<T: Message, O: Ownership> StructuralPartialEq for NSSet<T, O>
impl<T: Message + Sync> Sync for NSSet<T, Owned>
impl<T: Message + UnwindSafe> UnwindSafe for NSSet<T, Owned>
Auto Trait Implementations
impl<T, O = Shared> !Send for NSSet<T, O>
impl<T, O = Shared> !Sync for NSSet<T, O>
impl<T, O = Shared> !Unpin for NSSet<T, O>
impl<T, O = Shared> !UnwindSafe for NSSet<T, O>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more