swift_rs/types/
object.rs

1use crate::swift::{self, SwiftObject};
2use std::{ffi::c_void, ops::Deref, ptr::NonNull};
3
4#[doc(hidden)]
5#[repr(C)]
6pub struct SRObjectImpl<T> {
7    _nsobject_offset: u8,
8    data: T,
9}
10
11/// Wrapper for arbitrary `NSObject` types.
12///
13/// When returning an `NSObject`, its Rust type must be wrapped in `SRObject`.
14/// The type must also be annotated with `#[repr(C)]` to ensure its memory layout
15/// is identical to its Swift counterpart's.
16///
17/// ```rust
18/// use swift_rs::{swift, SRObject, Int, Bool};
19///
20/// #[repr(C)]
21/// struct CustomObject {
22///     a: Int,
23///     b: Bool
24/// }
25///
26/// swift!(fn get_custom_object() -> SRObject<CustomObject>);
27///
28/// let value = unsafe { get_custom_object() };
29///
30/// let reference: &CustomObject = value.as_ref();
31/// ```
32/// [_corresponding Swift code_](https://github.com/Brendonovich/swift-rs/blob/07269e511f1afb71e2fcfa89ca5d7338bceb20e8/tests/swift-pkg/doctests.swift#L49)
33#[repr(transparent)]
34pub struct SRObject<T>(pub(crate) NonNull<SRObjectImpl<T>>);
35
36impl<T> SwiftObject for SRObject<T> {
37    type Shape = T;
38
39    fn get_object(&self) -> &SRObject<Self::Shape> {
40        self
41    }
42}
43
44impl<T> Deref for SRObject<T> {
45    type Target = T;
46
47    fn deref(&self) -> &T {
48        unsafe { &self.0.as_ref().data }
49    }
50}
51
52impl<T> AsRef<T> for SRObject<T> {
53    fn as_ref(&self) -> &T {
54        self
55    }
56}
57
58impl<T> Drop for SRObject<T> {
59    fn drop(&mut self) {
60        unsafe { swift::release_object(self.0.as_ref() as *const _ as *const c_void) }
61    }
62}
63
64#[cfg(feature = "serde")]
65impl<T> serde::Serialize for SRObject<T>
66where
67    T: serde::Serialize,
68{
69    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
70    where
71        S: serde::Serializer,
72    {
73        self.deref().serialize(serializer)
74    }
75}
swift_rs/types/object.rs

swift_rs/types/
object.rs
