Struct objc2::foundation::NSDictionary
source · [−]foundation
only.Implementations
sourceimpl<K: Message, V: Message> NSDictionary<K, V>
impl<K: Message, V: Message> NSDictionary<K, V>
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;
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn get(&self, key: &K) -> Option<&V>
pub fn keys(&self) -> Vec<&K>
pub fn values(&self) -> Vec<&V>
pub fn keys_and_objects(&self) -> (Vec<&K>, Vec<&V>)
pub fn iter_keys(&self) -> NSEnumerator<'_, K>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn iter_values(&self) -> NSEnumerator<'_, V>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn keys_array(&self) -> Id<NSArray<K, 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 from_keys_and_objects<T>(
keys: &[&T],
vals: Vec<Id<V, Owned>>
) -> 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;
where
T: NSCopying<Output = K>,
pub fn into_values_array(dict: Id<Self, Owned>) -> Id<NSArray<V, Owned>, 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;
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<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSDictionary<K, V>
impl<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSDictionary<K, V>
sourceimpl<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn as_mut(&mut self) -> &mut NSDictionary<K, V>
fn as_mut(&mut self) -> &mut NSDictionary<K, V>
Converts this type into a mutable reference of the (usually inferred) input type.
sourceimpl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSDictionary<K, V>
impl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSDictionary<K, V>
sourceimpl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn as_ref(&self) -> &NSDictionary<K, V>
fn as_ref(&self) -> &NSDictionary<K, V>
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl<K: Message, V: Message> Borrow<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> Borrow<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn borrow(&self) -> &NSDictionary<K, V>
fn borrow(&self) -> &NSDictionary<K, V>
Immutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut NSDictionary<K, V>
fn borrow_mut(&mut self) -> &mut NSDictionary<K, V>
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<NSObject> for NSDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<NSObject> for NSDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<Object> for NSDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<Object> for NSDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> ClassType for NSDictionary<K, V>
impl<K: Message, V: Message> ClassType for NSDictionary<K, V>
sourceimpl<K: Message, V: Message> DefaultId for NSDictionary<K, V>
impl<K: Message, V: Message> DefaultId for NSDictionary<K, V>
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<K: Message, V: Message> Deref for NSDictionary<K, V>
impl<K: Message, V: Message> Deref for NSDictionary<K, V>
sourceimpl<K: Message, V: Message> DerefMut for NSDictionary<K, V>
impl<K: Message, V: Message> DerefMut for NSDictionary<K, V>
sourceimpl<K: Message, V: Message> NSFastEnumeration for NSDictionary<K, V>
impl<K: Message, V: Message> NSFastEnumeration for NSDictionary<K, V>
type Item = K
type Item = K
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.sourceimpl<K: PartialEq + Message, V: PartialEq + Message> PartialEq<NSDictionary<K, V>> for NSDictionary<K, V>
impl<K: PartialEq + Message, V: PartialEq + Message> PartialEq<NSDictionary<K, V>> for NSDictionary<K, V>
sourcefn eq(&self, other: &NSDictionary<K, V>) -> bool
fn eq(&self, other: &NSDictionary<K, V>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl<K: Message, V: Message> RefEncode for NSDictionary<K, V>
impl<K: Message, V: Message> RefEncode for NSDictionary<K, V>
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<K: Eq + Message, V: Eq + Message> Eq for NSDictionary<K, V>
impl<K: Message, V: Message> Message for NSDictionary<K, V>
impl<K: Message + RefUnwindSafe, V: Message + RefUnwindSafe> RefUnwindSafe for NSDictionary<K, V>
impl<K: Message + Sync + Send, V: Message + Send> Send for NSDictionary<K, V>
impl<K: Message, V: Message> StructuralEq for NSDictionary<K, V>
impl<K: Message, V: Message> StructuralPartialEq for NSDictionary<K, V>
impl<K: Message + Sync + Send, V: Message + Sync> Sync for NSDictionary<K, V>
impl<K: Message + UnwindSafe, V: Message + UnwindSafe> UnwindSafe for NSDictionary<K, V>
Auto Trait Implementations
impl<K, V> !Unpin for NSDictionary<K, V>
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