Struct SRObject

pub struct SRObject<T>(/* private fields */);

Wrapper for arbitrary NSObject types.

When returning an NSObject, its Rust type must be wrapped in SRObject. The type must also be annotated with #[repr(C)] to ensure its memory layout is identical to its Swift counterpart’s.

use swift_rs::{swift, SRObject, Int, Bool};

#[repr(C)]
struct CustomObject {
    a: Int,
    b: Bool
}

swift!(fn get_custom_object() -> SRObject<CustomObject>);

let value = unsafe { get_custom_object() };

let reference: &CustomObject = value.as_ref();

corresponding Swift code

Trait Implementations

impl<T> AsRef<T> for SRObject<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Deref for SRObject<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Drop for SRObject<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Serialize for SRObject<T>

where T: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, T: 'a> SwiftArg<'a> for SRObject<T>

type ArgType = SwiftRef<'a, SRObject<T>>

unsafe fn as_arg(&'a self) -> Self::ArgType

Creates a swift-compatible version of the argument. For primitives this just returns self, but for SwiftObject types it wraps them in SwiftRef.

impl<T> SwiftObject for SRObject<T>

type Shape = T

fn get_object(&self) -> &SRObject<Self::Shape>

Gets a reference to the SRObject at the root of a SwiftObject

unsafe fn swift_ref(&self) -> SwiftRef<'_, Self>

where Self: Sized,

Creates a SwiftRef for an object which can be used when calling a Swift function. This function should never be called manually, instead you should rely on the swift! macro to call it for you.

unsafe fn retain(&self)

where Self: Sized,

Adds a retain to an object.