#[repr(C)]pub struct NSPointerFunctions { /* private fields */ }
NSPointerFunctions
only.Expand description
Implementations§
Source§impl NSPointerFunctions
impl NSPointerFunctions
pub unsafe fn initWithOptions( this: Allocated<Self>, options: NSPointerFunctionsOptions, ) -> Retained<Self>
pub unsafe fn pointerFunctionsWithOptions( options: NSPointerFunctionsOptions, ) -> Retained<NSPointerFunctions>
pub unsafe fn hashFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> NSUInteger>
Sourcepub unsafe fn setHashFunction(
&self,
hash_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> NSUInteger>,
)
pub unsafe fn setHashFunction( &self, hash_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> NSUInteger>, )
Setter for hashFunction
.
pub unsafe fn isEqualFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>, NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> Bool>
Sourcepub unsafe fn setIsEqualFunction(
&self,
is_equal_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> Bool>,
)
pub unsafe fn setIsEqualFunction( &self, is_equal_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>) -> Bool>, )
Setter for isEqualFunction
.
pub unsafe fn sizeFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>
Sourcepub unsafe fn setSizeFunction(
&self,
size_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>,
)
pub unsafe fn setSizeFunction( &self, size_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>, )
Setter for sizeFunction
.
pub unsafe fn descriptionFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> *mut NSString>
NSString
only.Sourcepub unsafe fn setDescriptionFunction(
&self,
description_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> *mut NSString>,
)
Available on crate feature NSString
only.
pub unsafe fn setDescriptionFunction( &self, description_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> *mut NSString>, )
NSString
only.Setter for descriptionFunction
.
pub unsafe fn relinquishFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>)>
Sourcepub unsafe fn setRelinquishFunction(
&self,
relinquish_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>)>,
)
pub unsafe fn setRelinquishFunction( &self, relinquish_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>)>, )
Setter for relinquishFunction
.
pub unsafe fn acquireFunction( &self, ) -> Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>, Bool) -> NonNull<c_void>>
Sourcepub unsafe fn setAcquireFunction(
&self,
acquire_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>, Bool) -> NonNull<c_void>>,
)
pub unsafe fn setAcquireFunction( &self, acquire_function: Option<unsafe extern "C-unwind" fn(NonNull<c_void>, Option<unsafe extern "C-unwind" fn(NonNull<c_void>) -> NSUInteger>, Bool) -> NonNull<c_void>>, )
Setter for acquireFunction
.
pub unsafe fn usesStrongWriteBarrier(&self) -> bool
Sourcepub unsafe fn setUsesStrongWriteBarrier(&self, uses_strong_write_barrier: bool)
👎Deprecated: Garbage collection no longer supported
pub unsafe fn setUsesStrongWriteBarrier(&self, uses_strong_write_barrier: bool)
Setter for usesStrongWriteBarrier
.
pub unsafe fn usesWeakReadAndWriteBarriers(&self) -> bool
Sourcepub unsafe fn setUsesWeakReadAndWriteBarriers(
&self,
uses_weak_read_and_write_barriers: bool,
)
👎Deprecated: Garbage collection no longer supported
pub unsafe fn setUsesWeakReadAndWriteBarriers( &self, uses_weak_read_and_write_barriers: bool, )
Setter for usesWeakReadAndWriteBarriers
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
§Panics
May panic if the object is invalid (which may be the case for objects
returned from unavailable init
/new
methods).
§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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Attempt to downcast the object to a class of type T
.
This is the reference-variant. Use Retained::downcast
if you want
to convert a retained object to another type.
§Mutable classes
Some classes have immutable and mutable variants, such as NSString
and NSMutableString
.
When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.
So using this method to convert a NSString
to a NSMutableString
,
while not unsound, is generally frowned upon unless you created the
string yourself, or the API explicitly documents the string to be
mutable.
See Apple’s documentation on mutability and on
isKindOfClass:
for more details.
§Generic classes
Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.
You can, however, safely downcast to generic collections where all the
type-parameters are AnyObject
.
§Panics
This works internally by calling isKindOfClass:
. That means that the
object must have the instance method of that name, and an exception
will be thrown (if CoreFoundation is linked) or the process will abort
if that is not the case. In the vast majority of cases, you don’t need
to worry about this, since both root objects NSObject
and
NSProxy
implement this method.
§Examples
Cast an NSString
back and forth from NSObject
.
use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};
let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();
Try (and fail) to cast an NSObject
to an NSString
.
use objc2_foundation::{NSObject, NSString};
let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());
Try to cast to an array of strings.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();
This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.
Downcast when processing each element instead.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
for elem in arr {
if let Some(data) = elem.downcast_ref::<NSString>() {
// handle `data`
}
}
Trait Implementations§
Source§impl AsRef<AnyObject> for NSPointerFunctions
impl AsRef<AnyObject> for NSPointerFunctions
Source§impl AsRef<NSObject> for NSPointerFunctions
impl AsRef<NSObject> for NSPointerFunctions
Source§impl AsRef<NSPointerFunctions> for NSPointerFunctions
impl AsRef<NSPointerFunctions> for NSPointerFunctions
Source§impl Borrow<AnyObject> for NSPointerFunctions
impl Borrow<AnyObject> for NSPointerFunctions
Source§impl Borrow<NSObject> for NSPointerFunctions
impl Borrow<NSObject> for NSPointerFunctions
Source§impl ClassType for NSPointerFunctions
impl ClassType for NSPointerFunctions
Source§const NAME: &'static str = "NSPointerFunctions"
const NAME: &'static str = "NSPointerFunctions"
Source§type ThreadKind = <<NSPointerFunctions as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSPointerFunctions as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for NSPointerFunctions
Available on crate feature NSObject
only.
impl CopyingHelper for NSPointerFunctions
NSObject
only.Source§type Result = NSPointerFunctions
type Result = NSPointerFunctions
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for NSPointerFunctions
impl Debug for NSPointerFunctions
Source§impl Deref for NSPointerFunctions
impl Deref for NSPointerFunctions
Source§impl Hash for NSPointerFunctions
impl Hash for NSPointerFunctions
Source§impl Message for NSPointerFunctions
impl Message for NSPointerFunctions
Source§impl NSCopying for NSPointerFunctions
impl NSCopying for NSPointerFunctions
Source§impl NSObjectProtocol for NSPointerFunctions
impl NSObjectProtocol for NSPointerFunctions
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref