#[repr(C)]pub struct NSException { /* private fields */ }
NSException
only.Expand description
Implementations§
Source§impl NSException
impl NSException
Sourcepub fn new(
name: &NSExceptionName,
reason: Option<&NSString>,
user_info: Option<&NSDictionary>,
) -> Option<Retained<Self>>
Available on crate features NSObjCRuntime
and NSString
and NSDictionary
only.
pub fn new( name: &NSExceptionName, reason: Option<&NSString>, user_info: Option<&NSDictionary>, ) -> Option<Retained<Self>>
NSObjCRuntime
and NSString
and NSDictionary
only.Create a new NSException
object.
Returns None
if the exception couldn’t be created (example: If the
process is out of memory).
Sourcepub fn raise(&self) -> !
pub fn raise(&self) -> !
Raises the exception, causing program flow to jump to the local exception handler.
This is equivalent to using objc2::exception::throw
.
Source§impl NSException
impl NSException
pub unsafe fn exceptionWithName_reason_userInfo( name: &NSExceptionName, reason: Option<&NSString>, user_info: Option<&NSDictionary>, ) -> Retained<NSException>
NSDictionary
and NSObjCRuntime
and NSString
only.pub unsafe fn initWithName_reason_userInfo( this: Allocated<Self>, a_name: &NSExceptionName, a_reason: Option<&NSString>, a_user_info: Option<&NSDictionary>, ) -> Retained<Self>
NSDictionary
and NSObjCRuntime
and NSString
only.pub fn name(&self) -> Retained<NSExceptionName>
NSObjCRuntime
and NSString
only.pub fn reason(&self) -> Option<Retained<NSString>>
NSString
only.pub fn userInfo(&self) -> Option<Retained<NSDictionary>>
NSDictionary
only.pub unsafe fn callStackReturnAddresses(&self) -> Retained<NSArray<NSNumber>>
NSArray
and NSValue
only.pub unsafe fn callStackSymbols(&self) -> Retained<NSArray<NSString>>
NSArray
and NSString
only.Source§impl NSException
Methods declared on superclass NSObject
.
impl NSException
Methods declared on superclass NSObject
.
impl NSException
NSExceptionRaisingConveniences.
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 NSException
impl AsRef<AnyObject> for NSException
Source§impl AsRef<NSException> for NSException
impl AsRef<NSException> for NSException
Source§impl AsRef<NSObject> for NSException
impl AsRef<NSObject> for NSException
Source§impl Borrow<AnyObject> for NSException
impl Borrow<AnyObject> for NSException
Source§impl Borrow<NSObject> for NSException
impl Borrow<NSObject> for NSException
Source§impl ClassType for NSException
impl ClassType for NSException
Source§const NAME: &'static str = "NSException"
const NAME: &'static str = "NSException"
Source§type ThreadKind = <<NSException as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<NSException as ClassType>::Super as ClassType>::ThreadKind
Source§impl CopyingHelper for NSException
Available on crate feature NSObject
only.
impl CopyingHelper for NSException
NSObject
only.Source§type Result = NSException
type Result = NSException
Self
if the type has no
immutable counterpart. Read moreSource§impl Debug for NSException
impl Debug for NSException
Source§impl Deref for NSException
impl Deref for NSException
Source§impl Hash for NSException
impl Hash for NSException
Source§impl Message for NSException
impl Message for NSException
Source§impl NSCoding for NSException
impl NSCoding for NSException
Source§unsafe fn encodeWithCoder(&self, coder: &NSCoder)
unsafe fn encodeWithCoder(&self, coder: &NSCoder)
NSObject
and NSCoder
only.Source§impl NSCopying for NSException
impl NSCopying for NSException
Source§impl NSObjectProtocol for NSException
impl NSObjectProtocol for NSException
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
Source§fn isMemberOfClass(&self, cls: &AnyClass) -> bool
fn isMemberOfClass(&self, cls: &AnyClass) -> bool
Source§fn respondsToSelector(&self, aSelector: Sel) -> bool
fn respondsToSelector(&self, aSelector: Sel) -> bool
Source§fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
Source§fn debugDescription(&self) -> Retained<NSObject>
fn debugDescription(&self) -> Retained<NSObject>
Source§impl NSSecureCoding for NSException
impl NSSecureCoding for NSException
Source§impl PartialEq for NSException
impl PartialEq for NSException
Source§impl RefEncode for NSException
impl RefEncode for NSException
Source§const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF
Source§impl ToOwned for NSException
Available on crate feature NSObject
only.
impl ToOwned for NSException
NSObject
only.