Struct objc2_foundation::NSException

#[repr(C)]
pub struct NSException { /* private fields */ }

Available on crate feature NSException only.

Implementations

impl NSException

pub fn new( name: &NSExceptionName, reason: Option<&NSString>, user_info: Option<&NSDictionary> ) -> Option<Retained<Self>>

Available on crate features 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).

pub unsafe fn raise(&self) -> !

Raises the exception, causing program flow to jump to the local exception handler.

This is equivalent to using objc2::exception::throw.

Safety

Same as objc2::exception::throw.

pub fn into_exception(this: Retained<Self>) -> Retained<Exception>

Convert this into an Exception object.

pub fn from_exception( obj: Retained<Exception> ) -> Result<Retained<Self>, Retained<Exception>>

Create this from an Exception object.

This should be considered a hint; it may return Err in very, very few cases where the object is actually an instance of NSException.

impl NSException

pub unsafe fn exceptionWithName_reason_userInfo( name: &NSExceptionName, reason: Option<&NSString>, user_info: Option<&NSDictionary> ) -> Retained<NSException>

Available on crate features 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>

Available on crate features NSDictionary and NSObjCRuntime and NSString only.

pub fn name(&self) -> Retained<NSExceptionName>

Available on crate features NSObjCRuntime and NSString only.

pub fn reason(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

pub fn userInfo(&self) -> Option<Retained<NSDictionary>>

Available on crate feature NSDictionary only.

pub unsafe fn callStackReturnAddresses(&self) -> Retained<NSArray<NSNumber>>

Available on crate features NSArray and NSValue only.

pub unsafe fn callStackSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

impl NSException

Methods declared on superclass NSObject

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

impl NSException

This impl block contains no items.

NSExceptionRaisingConveniences

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

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

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use 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.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSException

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSException> for NSException

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<NSObject> for NSException

fn as_mut(&mut self) -> &mut NSObject

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

impl AsRef<AnyObject> for NSException

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSException> for NSException

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSException

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSException

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSException

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSException

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSException

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl ClassType for NSException

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSException"

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

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

fn retain(&self) -> Retained<Self>

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSException

Available on crate features NSObjCRuntime and NSString only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for NSException

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for NSException

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for NSException

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NSCoding for NSException

Available on crate feature NSObject only.

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate feature NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for NSException

Available on crate feature NSObject only.

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSException

fn isEqual(&self, other: &AnyObject) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for NSException

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSException

fn eq(&self, other: &NSException) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl RefEncode for NSException

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl ToOwned for NSException

Available on crate feature NSObject only.

type Owned = Retained<NSException>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

impl Eq for NSException

impl Message for NSException

impl RefUnwindSafe for NSException

impl Send for NSException

impl StructuralPartialEq for NSException

impl Sync for NSException

impl UnwindSafe for NSException