Struct objc2_foundation::NSError

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

Available on crate feature NSError only.

Implementations

impl NSError

Creation methods.

pub fn new(code: NSInteger, domain: &NSErrorDomain) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

Construct a new NSError with the given code in the given domain.

impl NSError

Accessor methods.

pub fn NSLocalizedDescriptionKey() -> &'static NSErrorUserInfoKey

Available on crate feature NSString only.

impl NSError

pub unsafe fn initWithDomain_code_userInfo( this: Allocated<Self>, domain: &NSErrorDomain, code: NSInteger, dict: Option<&NSDictionary<NSErrorUserInfoKey, AnyObject>> ) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

pub unsafe fn errorWithDomain_code_userInfo( domain: &NSErrorDomain, code: NSInteger, dict: Option<&NSDictionary<NSErrorUserInfoKey, AnyObject>> ) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

pub fn domain(&self) -> Retained<NSErrorDomain>

Available on crate feature NSString only.

pub fn code(&self) -> NSInteger

pub fn userInfo(&self) -> Retained<NSDictionary<NSErrorUserInfoKey, AnyObject>>

Available on crate features NSDictionary and NSString only.

pub fn localizedDescription(&self) -> Retained<NSString>

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate features NSArray and NSString only.

pub unsafe fn recoveryAttempter(&self) -> Option<Retained<AnyObject>>

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

Available on crate feature NSString only.

pub unsafe fn underlyingErrors(&self) -> Retained<NSArray<NSError>>

Available on crate feature NSArray only.

pub unsafe fn setUserInfoValueProviderForDomain_provider( error_domain: &NSErrorDomain, provider: Option<&Block<dyn Fn(NonNull<NSError>, NonNull<NSErrorUserInfoKey>) -> *mut AnyObject>> )

Available on crate features NSString and block2 only.

pub unsafe fn userInfoValueProviderForDomain( error_domain: &NSErrorDomain ) -> *mut Block<dyn Fn(NonNull<NSError>, NonNull<NSErrorUserInfoKey>) -> *mut AnyObject>

Available on crate features NSString and block2 only.

impl NSError

Methods declared on superclass NSObject

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

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 NSError

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

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

impl AsMut<NSError> for NSError

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

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

impl AsMut<NSObject> for NSError

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

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

impl AsRef<AnyObject> for NSError

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSError> for NSError

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSError

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSError

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSError

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSError

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSError

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

Mutably borrows from an owned value.

impl ClassType for NSError

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSError"

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 NSError

Available on crate features NSString and NSDictionary only.

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

Formats the value using the given formatter.

impl Deref for NSError

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSError

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

Mutably dereferences the value.

impl Display for NSError

Available on crate feature NSString only.

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

Formats the value using the given formatter.

impl Error for NSError

Available on crate features NSString and NSDictionary only.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl Hash for NSError

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 NSError

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 NSError

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 NSError

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 NSError

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSError

fn eq(&self, other: &NSError) -> 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 NSError

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

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

impl Eq for NSError

impl Message for NSError

impl RefUnwindSafe for NSError

impl Send for NSError

impl StructuralPartialEq for NSError

impl Sync for NSError

impl UnwindSafe for NSError