objc2-foundation 0.3.2

Bindings to the Foundation framework
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
135
136

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;

use crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsclassdescription?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct NSClassDescription;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for NSClassDescription {}
);

impl NSClassDescription {
    extern_methods!(
        /// # Safety
        ///
        /// `a_class` probably has further requirements.
        #[unsafe(method(registerClassDescription:forClass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn registerClassDescription_forClass(
            description: &NSClassDescription,
            a_class: &AnyClass,
        );

        #[unsafe(method(invalidateClassDescriptionCache))]
        #[unsafe(method_family = none)]
        pub fn invalidateClassDescriptionCache();

        /// # Safety
        ///
        /// `a_class` probably has further requirements.
        #[unsafe(method(classDescriptionForClass:))]
        #[unsafe(method_family = none)]
        pub unsafe fn classDescriptionForClass(
            a_class: &AnyClass,
        ) -> Option<Retained<NSClassDescription>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(attributeKeys))]
        #[unsafe(method_family = none)]
        pub fn attributeKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(toOneRelationshipKeys))]
        #[unsafe(method_family = none)]
        pub fn toOneRelationshipKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(toManyRelationshipKeys))]
        #[unsafe(method_family = none)]
        pub fn toManyRelationshipKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(feature = "NSString")]
        #[unsafe(method(inverseForRelationshipKey:))]
        #[unsafe(method_family = none)]
        pub fn inverseForRelationshipKey(
            &self,
            relationship_key: &NSString,
        ) -> Option<Retained<NSString>>;
    );
}

/// Methods declared on superclass `NSObject`.
impl NSClassDescription {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub fn new() -> Retained<Self>;
    );
}

impl DefaultRetained for NSClassDescription {
    #[inline]
    fn default_retained() -> Retained<Self> {
        Self::new()
    }
}

mod private_NSObjectNSClassDescriptionPrimitives {
    pub trait Sealed {}
}

/// Category "NSClassDescriptionPrimitives" on [`NSObject`].
#[doc(alias = "NSClassDescriptionPrimitives")]
pub unsafe trait NSObjectNSClassDescriptionPrimitives:
    ClassType + Sized + private_NSObjectNSClassDescriptionPrimitives::Sealed
{
    extern_methods!(
        #[unsafe(method(classDescription))]
        #[unsafe(method_family = none)]
        fn classDescription(&self) -> Retained<NSClassDescription>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(attributeKeys))]
        #[unsafe(method_family = none)]
        fn attributeKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(toOneRelationshipKeys))]
        #[unsafe(method_family = none)]
        fn toOneRelationshipKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[unsafe(method(toManyRelationshipKeys))]
        #[unsafe(method_family = none)]
        fn toManyRelationshipKeys(&self) -> Retained<NSArray<NSString>>;

        #[cfg(feature = "NSString")]
        #[unsafe(method(inverseForRelationshipKey:))]
        #[unsafe(method_family = none)]
        fn inverseForRelationshipKey(
            &self,
            relationship_key: &NSString,
        ) -> Option<Retained<NSString>>;
    );
}

impl private_NSObjectNSClassDescriptionPrimitives::Sealed for NSObject {}
unsafe impl NSObjectNSClassDescriptionPrimitives for NSObject {}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsclassdescriptionneededforclassnotification?language=objc)
    #[cfg(all(feature = "NSNotification", feature = "NSString"))]
    pub static NSClassDescriptionNeededForClassNotification: &'static NSNotificationName;
}