Struct objc2_foundation::NSException

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

A special condition that interrupts the normal flow of program execution.

Exceptions can be thrown and caught using the objc2::exception module.

See also Apple’s documentation.

Implementations

impl NSException

pub fn class() -> &'static Class

Get a reference to the Objective-C class NSException.

impl NSException

pub fn new(
    name: &NSString,
    reason: Option<&NSString>,
    user_info: Option<&NSDictionary<Object, Object>>
) -> Option<Id<Self, Shared>>

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 name(&self) -> Id<NSString, Shared>

A that uniquely identifies the type of exception.

See Apple’s documentation for some of the different values this can take.

pub fn reason(&self) -> Option<Id<NSString, Shared>>

A human-readable message summarizing the reason for the exception.

pub fn user_info(&self) -> Option<Id<NSDictionary<Object, Object>, Shared>>

Application-specific data pertaining to the exception.

pub fn into_exception(this: Id<Self, Shared>) -> Id<Exception, Shared>

Convert this into an Exception object.

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

Convert this into an Exception object.

Methods from Deref<Target = NSObject>

pub fn hash_code(&self) -> usize

pub fn is_equal(&self, other: &NSObject) -> bool

pub fn description(&self) -> Id<NSString, Shared>

pub fn is_kind_of(&self, cls: &Class) -> bool

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

pub unsafe fn ivar_ptr<T>(&self, name: &str) -> *mut T where
    T: Encode, 

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.

pub unsafe fn ivar<T>(&self, name: &str) -> &T where
    T: Encode, 

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).

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

👎 Deprecated:

Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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

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.

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

👎 Deprecated:

Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T) where
    T: Encode, 

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

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 AsMut<Object> for NSException

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

Converts this type into a mutable 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 AsRef<Object> for NSException

fn as_ref(&self) -> &Object

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

impl Borrow<NSObject> for NSException

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<Object> for NSException

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl BorrowMut<NSObject> for NSException

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSException

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

Mutably borrows from an owned value.

impl Debug for NSException

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, 

Feeds a slice of this type into the given Hasher.

impl NSCopying for NSException

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSException

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl PartialEq<NSException> 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: &NSException) -> bool

This method tests for !=.

impl RefEncode for NSException

const ENCODING_REF: Encoding<'static> = <NSObject as crate::objc2::RefEncode>::ENCODING_REF

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

impl ToOwned for NSException

type Owned = Id<NSException, Shared>

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 StructuralEq for NSException

impl StructuralPartialEq for NSException

impl Sync for NSException

impl UnwindSafe for NSException