fruity__bbqsrc 0.2.0

Rusty bindings for Apple libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use super::NSString;
use crate::core::Arc;
use crate::objc::{NSInteger, NSObject};
use std::fmt;

mod domain;
mod recovery_attempting;
mod user_info_key;

pub use domain::*;
pub use recovery_attempting::*;
pub use user_info_key::*;

// TODO: Add error codes for Cocoa, Mach, and POSIX.

objc_subclass! {
    /// Information about an error condition including a domain, a domain-specific
    /// error code, and application-specific information.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror).
    ///
    /// # Formatting
    ///
    /// The [`Display`](std::fmt::Display) implementation writes the result of
    /// [`localized_description`](Self::localized_description).
    pub class NSError<'data>: NSObject<'data>;
}

// TODO: `fmt::Debug`

impl fmt::Display for NSError<'_> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.localized_description().fmt(f)
    }
}

impl NSError<'_> {
    // TODO: `new(domain: &NSErrorDomain, code: NSInteger, user_info: &NSDictionary<NSErrorUserInfoKey, id>) -> Arc<Self>`
}

/// Getting error properties.
impl NSError<'_> {
    /// Returns the error code.
    ///
    /// Note that errors are domain-specific.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1409165-code).
    #[inline]
    pub fn code(&self) -> NSInteger {
        unsafe { _msg_send_any![self, code] }
    }

    /// Returns a string containing the error domain.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1413924-domain).
    #[inline]
    pub fn domain(&self) -> Arc<NSErrorDomain> {
        unsafe { _msg_send_any![self, domain] }
    }

    // TODO: `userInfo`
}

/// Getting error user info.
impl NSError<'_> {
    /// Returns a string containing the localized description of the error.
    ///
    /// This is the object in the user info dictionary for
    /// [`NSErrorUserInfoKey::localized_description`]. If it doesn't exist, a
    /// default string is constructed from the domain and code.
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1413924-domain).
    #[inline]
    #[doc(alias = "localizedDescription")]
    pub fn localized_description(&self) -> Arc<NSString> {
        unsafe { _msg_send_any![self, localizedDescription] }
    }

    /// Returns a string containing the localized explanation of the reason for
    /// the error.
    ///
    /// This is the object in the user info dictionary for
    /// [`NSErrorUserInfoKey::localized_failure_reason`].
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1412752-localizedfailurereason).
    #[inline]
    #[doc(alias = "localizedFailureReason")]
    pub fn localized_failure_reason(&self) -> Option<Arc<NSString>> {
        unsafe { _msg_send_any![self, localizedFailureReason] }
    }

    // TODO: `localizedRecoveryOptions`

    /// Returns a string containing the localized recovery suggestion for the
    /// error.
    ///
    /// This is the object in the user info dictionary for
    /// [`NSErrorUserInfoKey::localized_recovery_suggestion`].
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1407500-localizedrecoverysuggestion).
    #[inline]
    #[doc(alias = "localizedRecoverySuggestion")]
    pub fn localized_recovery_suggestion(&self) -> Option<Arc<NSString>> {
        unsafe { _msg_send_any![self, localizedRecoverySuggestion] }
    }

    /// Returns the object in the user info dictionary corresponding to
    /// [`NSErrorUserInfoKey::recovery_attempter`].
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1408864-recoveryattempter).
    #[inline]
    #[doc(alias = "recoveryAttempter")]
    pub fn recovery_attempter(&self) -> Option<Arc<NSErrorRecoveryAttempting>> {
        unsafe { _msg_send_any![self, recoveryAttempter] }
    }

    /// Returns the object in the user info dictionary corresponding to
    /// [`NSErrorUserInfoKey::help_anchor`].
    ///
    /// See [documentation](https://developer.apple.com/documentation/foundation/nserror/1414718-helpanchor).
    #[inline]
    #[doc(alias = "helpAnchor")]
    pub fn help_anchor(&self) -> Option<Arc<NSString>> {
        unsafe { _msg_send_any![self, helpAnchor] }
    }
}

/// Providing error user info.
impl NSError<'_> {
    // TODO: Methods that use blocks:
    // - `userInfoValueProviderForDomain:`
    // - `setUserInfoValueProviderForDomain:provider:`
}