Struct NSError

#[repr(C)]
pub struct NSError {
    pub ptr: Id<Object>,
}

Information about an error condition including a domain, a domain-specific error code, and application-specific information.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NSError

pub fn error_with_domain_code_user_info( domain: NSErrorDomain, code: Int, dict: NSDictionary<NSErrorUserInfoKey, id>, ) -> Self

Creates and initializes an NSError object for a given domain and code with a given userInfo dictionary.

pub fn init_with_domain_code_user_info( &mut self, domain: NSErrorDomain, code: Int, dict: NSDictionary<NSErrorUserInfoKey, id>, ) -> Self

where Self: Sized + FromId,

Returns an NSError object initialized for a given domain and code with a given userInfo dictionary.

pub fn code(&self) -> Int

The error code.

pub fn domain(&self) -> NSErrorDomain

A string containing the error domain.

pub fn user_info(&self) -> NSDictionary<NSErrorUserInfoKey, id>

The user info dictionary.

pub fn localized_description(&self) -> NSString

A string containing the localized description of the error.

pub fn localized_recovery_options(&self) -> NSArray<NSString>

An array containing the localized titles of buttons appropriate for displaying in an alert panel.

pub fn localized_recovery_suggestion(&self) -> NSString

A string containing the localized recovery suggestion for the error.

pub fn localized_failure_reason(&self) -> NSString

A string containing the localized explanation of the reason for the error.

pub fn recovery_attempter(&self) -> id

The object in the user info dictionary corresponding to the NSRecoveryAttempterErrorKey key.

pub fn attempt_recovery_from_error_option_index( &self, error: NSError, recovery_index: UInt, ) -> bool

Implemented to attempt a recovery from an error noted in an application-modal dialog.

pub fn help_anchor(&self) -> NSString

A string to display in response to an alert panel help anchor button being pressed.

pub fn underlying_errors(&self) -> NSArray<NSError>

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

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

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NSError

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NSError

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

Formats the value using the given formatter.

impl Deref for NSError

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSError

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

Mutably dereferences the value.

impl Display for NSError

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

Formats the value using the given formatter.

impl Encode for NSError

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NSError

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

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 INSError for NSError

fn m_error_with_domain_code_user_info( domain: NSErrorDomain, code: Int, dict: NSDictionary<NSErrorUserInfoKey, id>, ) -> Self

where Self: Sized + FromId,

Creates and initializes an NSError object for a given domain and code with a given userInfo dictionary.

fn m_init_with_domain_code_user_info( &mut self, domain: NSErrorDomain, code: Int, dict: NSDictionary<NSErrorUserInfoKey, id>, ) -> Self

where Self: Sized + FromId,

Returns an NSError object initialized for a given domain and code with a given userInfo dictionary.

fn p_code(&self) -> Int

The error code.

fn p_domain(&self) -> NSErrorDomain

A string containing the error domain.

fn p_user_info(&self) -> NSDictionary<NSErrorUserInfoKey, id>

The user info dictionary.

fn p_localized_description(&self) -> NSString

A string containing the localized description of the error.

fn p_localized_recovery_options(&self) -> NSArray<NSString>

An array containing the localized titles of buttons appropriate for displaying in an alert panel.

fn p_localized_recovery_suggestion(&self) -> NSString

A string containing the localized recovery suggestion for the error.

fn p_localized_failure_reason(&self) -> NSString

A string containing the localized explanation of the reason for the error.

fn p_recovery_attempter(&self) -> id

The object in the user info dictionary corresponding to the NSRecoveryAttempterErrorKey key.

fn m_attempt_recovery_from_error_option_index( &self, error: NSError, recovery_index: UInt, ) -> bool

Implemented to attempt a recovery from an error noted in an application-modal dialog.

fn m_help_anchor(&self) -> NSString

A string to display in response to an alert panel help anchor button being pressed.

fn p_underlying_errors(&self) -> NSArray<NSError>

impl PNSObject for NSError

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

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

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NSError

fn to_id(self) -> id

Returns id representation of the object.