Struct objc2::foundation::NSException

source ·

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

Expand description

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

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

Implementations§

source §

impl NSException

source

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

source

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.

source

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.

source

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

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

source

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

Application-specific data pertaining to the exception.

source

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

Convert this into an Exception object.

source

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

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.

Methods from Deref<Target = NSObject>§

source

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>§

source

pub fn class(&self) -> &Class

Dynamically find the class of this object.

source

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.

source

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

source

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

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

source

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.

source