objc2_foundation/generated/
NSCharacterSet.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6#[cfg(feature = "objc2-core-foundation")]
7use objc2_core_foundation::*;
8
9use crate::*;
10
11/// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsopenstepunicodereservedbase?language=objc)
12pub const NSOpenStepUnicodeReservedBase: c_uint = 0xF400;
13
14extern_class!(
15    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nscharacterset?language=objc)
16    #[unsafe(super(NSObject))]
17    #[derive(Debug, PartialEq, Eq, Hash)]
18    pub struct NSCharacterSet;
19);
20
21#[cfg(feature = "objc2-core-foundation")]
22impl AsRef<NSCharacterSet> for CFCharacterSet {
23    #[inline]
24    fn as_ref(&self) -> &NSCharacterSet {
25        unsafe { &*((self as *const Self).cast()) }
26    }
27}
28
29#[cfg(feature = "objc2-core-foundation")]
30impl AsRef<CFCharacterSet> for NSCharacterSet {
31    #[inline]
32    fn as_ref(&self) -> &CFCharacterSet {
33        unsafe { &*((self as *const Self).cast()) }
34    }
35}
36
37#[cfg(feature = "NSObject")]
38extern_conformance!(
39    unsafe impl NSCoding for NSCharacterSet {}
40);
41
42#[cfg(feature = "NSObject")]
43extern_conformance!(
44    unsafe impl NSCopying for NSCharacterSet {}
45);
46
47#[cfg(feature = "NSObject")]
48unsafe impl CopyingHelper for NSCharacterSet {
49    type Result = Self;
50}
51
52#[cfg(feature = "NSObject")]
53extern_conformance!(
54    unsafe impl NSMutableCopying for NSCharacterSet {}
55);
56
57#[cfg(feature = "NSObject")]
58unsafe impl MutableCopyingHelper for NSCharacterSet {
59    type Result = NSMutableCharacterSet;
60}
61
62extern_conformance!(
63    unsafe impl NSObjectProtocol for NSCharacterSet {}
64);
65
66#[cfg(feature = "NSObject")]
67extern_conformance!(
68    unsafe impl NSSecureCoding for NSCharacterSet {}
69);
70
71impl NSCharacterSet {
72    extern_methods!(
73        #[unsafe(method(controlCharacterSet))]
74        #[unsafe(method_family = none)]
75        pub fn controlCharacterSet() -> Retained<NSCharacterSet>;
76
77        #[unsafe(method(whitespaceCharacterSet))]
78        #[unsafe(method_family = none)]
79        pub fn whitespaceCharacterSet() -> Retained<NSCharacterSet>;
80
81        #[unsafe(method(whitespaceAndNewlineCharacterSet))]
82        #[unsafe(method_family = none)]
83        pub fn whitespaceAndNewlineCharacterSet() -> Retained<NSCharacterSet>;
84
85        #[unsafe(method(decimalDigitCharacterSet))]
86        #[unsafe(method_family = none)]
87        pub fn decimalDigitCharacterSet() -> Retained<NSCharacterSet>;
88
89        #[unsafe(method(letterCharacterSet))]
90        #[unsafe(method_family = none)]
91        pub fn letterCharacterSet() -> Retained<NSCharacterSet>;
92
93        #[unsafe(method(lowercaseLetterCharacterSet))]
94        #[unsafe(method_family = none)]
95        pub fn lowercaseLetterCharacterSet() -> Retained<NSCharacterSet>;
96
97        #[unsafe(method(uppercaseLetterCharacterSet))]
98        #[unsafe(method_family = none)]
99        pub fn uppercaseLetterCharacterSet() -> Retained<NSCharacterSet>;
100
101        #[unsafe(method(nonBaseCharacterSet))]
102        #[unsafe(method_family = none)]
103        pub fn nonBaseCharacterSet() -> Retained<NSCharacterSet>;
104
105        #[unsafe(method(alphanumericCharacterSet))]
106        #[unsafe(method_family = none)]
107        pub fn alphanumericCharacterSet() -> Retained<NSCharacterSet>;
108
109        #[unsafe(method(decomposableCharacterSet))]
110        #[unsafe(method_family = none)]
111        pub fn decomposableCharacterSet() -> Retained<NSCharacterSet>;
112
113        #[unsafe(method(illegalCharacterSet))]
114        #[unsafe(method_family = none)]
115        pub fn illegalCharacterSet() -> Retained<NSCharacterSet>;
116
117        #[unsafe(method(punctuationCharacterSet))]
118        #[unsafe(method_family = none)]
119        pub fn punctuationCharacterSet() -> Retained<NSCharacterSet>;
120
121        #[unsafe(method(capitalizedLetterCharacterSet))]
122        #[unsafe(method_family = none)]
123        pub fn capitalizedLetterCharacterSet() -> Retained<NSCharacterSet>;
124
125        #[unsafe(method(symbolCharacterSet))]
126        #[unsafe(method_family = none)]
127        pub fn symbolCharacterSet() -> Retained<NSCharacterSet>;
128
129        #[unsafe(method(newlineCharacterSet))]
130        #[unsafe(method_family = none)]
131        pub fn newlineCharacterSet() -> Retained<NSCharacterSet>;
132
133        #[cfg(feature = "NSRange")]
134        #[unsafe(method(characterSetWithRange:))]
135        #[unsafe(method_family = none)]
136        pub fn characterSetWithRange(a_range: NSRange) -> Retained<NSCharacterSet>;
137
138        #[cfg(feature = "NSString")]
139        #[unsafe(method(characterSetWithCharactersInString:))]
140        #[unsafe(method_family = none)]
141        pub fn characterSetWithCharactersInString(a_string: &NSString) -> Retained<NSCharacterSet>;
142
143        #[cfg(feature = "NSData")]
144        #[unsafe(method(characterSetWithBitmapRepresentation:))]
145        #[unsafe(method_family = none)]
146        pub fn characterSetWithBitmapRepresentation(data: &NSData) -> Retained<NSCharacterSet>;
147
148        #[cfg(feature = "NSString")]
149        #[unsafe(method(characterSetWithContentsOfFile:))]
150        #[unsafe(method_family = none)]
151        pub fn characterSetWithContentsOfFile(
152            f_name: &NSString,
153        ) -> Option<Retained<NSCharacterSet>>;
154
155        #[cfg(feature = "NSCoder")]
156        /// # Safety
157        ///
158        /// `coder` possibly has further requirements.
159        #[unsafe(method(initWithCoder:))]
160        #[unsafe(method_family = init)]
161        pub unsafe fn initWithCoder(this: Allocated<Self>, coder: &NSCoder) -> Retained<Self>;
162
163        #[cfg(feature = "NSString")]
164        #[unsafe(method(characterIsMember:))]
165        #[unsafe(method_family = none)]
166        pub fn characterIsMember(&self, a_character: unichar) -> bool;
167
168        #[cfg(feature = "NSData")]
169        #[unsafe(method(bitmapRepresentation))]
170        #[unsafe(method_family = none)]
171        pub fn bitmapRepresentation(&self) -> Retained<NSData>;
172
173        #[unsafe(method(invertedSet))]
174        #[unsafe(method_family = none)]
175        pub fn invertedSet(&self) -> Retained<NSCharacterSet>;
176
177        #[unsafe(method(longCharacterIsMember:))]
178        #[unsafe(method_family = none)]
179        pub fn longCharacterIsMember(&self, the_long_char: UTF32Char) -> bool;
180
181        #[unsafe(method(isSupersetOfSet:))]
182        #[unsafe(method_family = none)]
183        pub fn isSupersetOfSet(&self, the_other_set: &NSCharacterSet) -> bool;
184
185        #[unsafe(method(hasMemberInPlane:))]
186        #[unsafe(method_family = none)]
187        pub fn hasMemberInPlane(&self, the_plane: u8) -> bool;
188    );
189}
190
191/// Methods declared on superclass `NSObject`.
192impl NSCharacterSet {
193    extern_methods!(
194        #[unsafe(method(init))]
195        #[unsafe(method_family = init)]
196        pub fn init(this: Allocated<Self>) -> Retained<Self>;
197
198        #[unsafe(method(new))]
199        #[unsafe(method_family = new)]
200        pub fn new() -> Retained<Self>;
201    );
202}
203
204impl DefaultRetained for NSCharacterSet {
205    #[inline]
206    fn default_retained() -> Retained<Self> {
207        Self::new()
208    }
209}
210
211extern_class!(
212    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsmutablecharacterset?language=objc)
213    #[unsafe(super(NSCharacterSet, NSObject))]
214    #[derive(Debug, PartialEq, Eq, Hash)]
215    pub struct NSMutableCharacterSet;
216);
217
218#[cfg(feature = "objc2-core-foundation")]
219impl AsRef<NSMutableCharacterSet> for CFMutableCharacterSet {
220    #[inline]
221    fn as_ref(&self) -> &NSMutableCharacterSet {
222        unsafe { &*((self as *const Self).cast()) }
223    }
224}
225
226#[cfg(feature = "objc2-core-foundation")]
227impl AsRef<CFMutableCharacterSet> for NSMutableCharacterSet {
228    #[inline]
229    fn as_ref(&self) -> &CFMutableCharacterSet {
230        unsafe { &*((self as *const Self).cast()) }
231    }
232}
233
234#[cfg(feature = "NSObject")]
235extern_conformance!(
236    unsafe impl NSCoding for NSMutableCharacterSet {}
237);
238
239#[cfg(feature = "NSObject")]
240extern_conformance!(
241    unsafe impl NSCopying for NSMutableCharacterSet {}
242);
243
244#[cfg(feature = "NSObject")]
245unsafe impl CopyingHelper for NSMutableCharacterSet {
246    type Result = NSCharacterSet;
247}
248
249#[cfg(feature = "NSObject")]
250extern_conformance!(
251    unsafe impl NSMutableCopying for NSMutableCharacterSet {}
252);
253
254#[cfg(feature = "NSObject")]
255unsafe impl MutableCopyingHelper for NSMutableCharacterSet {
256    type Result = Self;
257}
258
259extern_conformance!(
260    unsafe impl NSObjectProtocol for NSMutableCharacterSet {}
261);
262
263#[cfg(feature = "NSObject")]
264extern_conformance!(
265    unsafe impl NSSecureCoding for NSMutableCharacterSet {}
266);
267
268impl NSMutableCharacterSet {
269    extern_methods!(
270        #[cfg(feature = "NSRange")]
271        #[unsafe(method(addCharactersInRange:))]
272        #[unsafe(method_family = none)]
273        pub fn addCharactersInRange(&self, a_range: NSRange);
274
275        #[cfg(feature = "NSRange")]
276        #[unsafe(method(removeCharactersInRange:))]
277        #[unsafe(method_family = none)]
278        pub fn removeCharactersInRange(&self, a_range: NSRange);
279
280        #[cfg(feature = "NSString")]
281        #[unsafe(method(addCharactersInString:))]
282        #[unsafe(method_family = none)]
283        pub fn addCharactersInString(&self, a_string: &NSString);
284
285        #[cfg(feature = "NSString")]
286        #[unsafe(method(removeCharactersInString:))]
287        #[unsafe(method_family = none)]
288        pub fn removeCharactersInString(&self, a_string: &NSString);
289
290        #[unsafe(method(formUnionWithCharacterSet:))]
291        #[unsafe(method_family = none)]
292        pub fn formUnionWithCharacterSet(&self, other_set: &NSCharacterSet);
293
294        #[unsafe(method(formIntersectionWithCharacterSet:))]
295        #[unsafe(method_family = none)]
296        pub fn formIntersectionWithCharacterSet(&self, other_set: &NSCharacterSet);
297
298        #[unsafe(method(invert))]
299        #[unsafe(method_family = none)]
300        pub fn invert(&self);
301
302        #[unsafe(method(controlCharacterSet))]
303        #[unsafe(method_family = none)]
304        pub fn controlCharacterSet() -> Retained<NSMutableCharacterSet>;
305
306        #[unsafe(method(whitespaceCharacterSet))]
307        #[unsafe(method_family = none)]
308        pub fn whitespaceCharacterSet() -> Retained<NSMutableCharacterSet>;
309
310        #[unsafe(method(whitespaceAndNewlineCharacterSet))]
311        #[unsafe(method_family = none)]
312        pub fn whitespaceAndNewlineCharacterSet() -> Retained<NSMutableCharacterSet>;
313
314        #[unsafe(method(decimalDigitCharacterSet))]
315        #[unsafe(method_family = none)]
316        pub fn decimalDigitCharacterSet() -> Retained<NSMutableCharacterSet>;
317
318        #[unsafe(method(letterCharacterSet))]
319        #[unsafe(method_family = none)]
320        pub fn letterCharacterSet() -> Retained<NSMutableCharacterSet>;
321
322        #[unsafe(method(lowercaseLetterCharacterSet))]
323        #[unsafe(method_family = none)]
324        pub fn lowercaseLetterCharacterSet() -> Retained<NSMutableCharacterSet>;
325
326        #[unsafe(method(uppercaseLetterCharacterSet))]
327        #[unsafe(method_family = none)]
328        pub fn uppercaseLetterCharacterSet() -> Retained<NSMutableCharacterSet>;
329
330        #[unsafe(method(nonBaseCharacterSet))]
331        #[unsafe(method_family = none)]
332        pub fn nonBaseCharacterSet() -> Retained<NSMutableCharacterSet>;
333
334        #[unsafe(method(alphanumericCharacterSet))]
335        #[unsafe(method_family = none)]
336        pub fn alphanumericCharacterSet() -> Retained<NSMutableCharacterSet>;
337
338        #[unsafe(method(decomposableCharacterSet))]
339        #[unsafe(method_family = none)]
340        pub fn decomposableCharacterSet() -> Retained<NSMutableCharacterSet>;
341
342        #[unsafe(method(illegalCharacterSet))]
343        #[unsafe(method_family = none)]
344        pub fn illegalCharacterSet() -> Retained<NSMutableCharacterSet>;
345
346        #[unsafe(method(punctuationCharacterSet))]
347        #[unsafe(method_family = none)]
348        pub fn punctuationCharacterSet() -> Retained<NSMutableCharacterSet>;
349
350        #[unsafe(method(capitalizedLetterCharacterSet))]
351        #[unsafe(method_family = none)]
352        pub fn capitalizedLetterCharacterSet() -> Retained<NSMutableCharacterSet>;
353
354        #[unsafe(method(symbolCharacterSet))]
355        #[unsafe(method_family = none)]
356        pub fn symbolCharacterSet() -> Retained<NSMutableCharacterSet>;
357
358        #[unsafe(method(newlineCharacterSet))]
359        #[unsafe(method_family = none)]
360        pub fn newlineCharacterSet() -> Retained<NSMutableCharacterSet>;
361
362        #[cfg(feature = "NSRange")]
363        #[unsafe(method(characterSetWithRange:))]
364        #[unsafe(method_family = none)]
365        pub fn characterSetWithRange(a_range: NSRange) -> Retained<NSMutableCharacterSet>;
366
367        #[cfg(feature = "NSString")]
368        #[unsafe(method(characterSetWithCharactersInString:))]
369        #[unsafe(method_family = none)]
370        pub fn characterSetWithCharactersInString(
371            a_string: &NSString,
372        ) -> Retained<NSMutableCharacterSet>;
373
374        #[cfg(feature = "NSData")]
375        #[unsafe(method(characterSetWithBitmapRepresentation:))]
376        #[unsafe(method_family = none)]
377        pub fn characterSetWithBitmapRepresentation(
378            data: &NSData,
379        ) -> Retained<NSMutableCharacterSet>;
380
381        #[cfg(feature = "NSString")]
382        #[unsafe(method(characterSetWithContentsOfFile:))]
383        #[unsafe(method_family = none)]
384        pub fn characterSetWithContentsOfFile(
385            f_name: &NSString,
386        ) -> Option<Retained<NSMutableCharacterSet>>;
387    );
388}
389
390/// Methods declared on superclass `NSCharacterSet`.
391impl NSMutableCharacterSet {
392    extern_methods!(
393        #[cfg(feature = "NSCoder")]
394        /// # Safety
395        ///
396        /// `coder` possibly has further requirements.
397        #[unsafe(method(initWithCoder:))]
398        #[unsafe(method_family = init)]
399        pub unsafe fn initWithCoder(this: Allocated<Self>, coder: &NSCoder) -> Retained<Self>;
400    );
401}
402
403/// Methods declared on superclass `NSObject`.
404impl NSMutableCharacterSet {
405    extern_methods!(
406        #[unsafe(method(init))]
407        #[unsafe(method_family = init)]
408        pub fn init(this: Allocated<Self>) -> Retained<Self>;
409
410        #[unsafe(method(new))]
411        #[unsafe(method_family = new)]
412        pub fn new() -> Retained<Self>;
413    );
414}
415
416impl DefaultRetained for NSMutableCharacterSet {
417    #[inline]
418    fn default_retained() -> Retained<Self> {
419        Self::new()
420    }
421}
objc2_foundation/generated/NSCharacterSet.rs

objc2_foundation/generated/
NSCharacterSet.rs
