Struct UiKitWindowHandle

#[non_exhaustive]
pub struct UiKitWindowHandle {
    pub ui_view: NonNull<c_void>,
    pub ui_view_controller: Option<NonNull<c_void>>,
}

Raw window handle for UIKit.

Note that UIView can only be accessed from the main thread of the application. This struct is !Send and !Sync to help with ensuring that.

Example

Getting the view from a WindowHandle.

#![cfg(any(target_os = "ios", target_os = "tvos", target_os = "watchos", target_os = "xros"))]
use objc2_foundation::is_main_thread;
use objc2::rc::Id;
use objc2_ui_kit::UIView;
use raw_window_handle::{WindowHandle, RawWindowHandle};

let handle: WindowHandle<'_>; // Get the window handle from somewhere else
match handle.as_raw() {
    RawWindowHandle::UIKit(handle) => {
        assert!(is_main_thread(), "can only access UIKit handles on the main thread");
        let ui_view = handle.ui_view.as_ptr();
        // SAFETY: The pointer came from `WindowHandle`, which ensures
        // that the `UiKitWindowHandle` contains a valid pointer to an
        // `UIView`.
        // Unwrap is fine, since the pointer came from `NonNull`.
        let ui_view: Id<UIView> = unsafe { Id::retain(ui_view.cast()) }.unwrap();
        // Do something with the UIView here.
    }
    handle => unreachable!("unknown handle {handle:?} for platform"),
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ui_view: NonNull<c_void>

A pointer to an UIView object.

ui_view_controller: Option<NonNull<c_void>>

A pointer to an UIViewController object, if the view has one.

Implementations

impl UiKitWindowHandle

pub fn new(ui_view: NonNull<c_void>) -> UiKitWindowHandle

Create a new handle to a view.

Example

let view: &UIView;
let mut handle = UiKitWindowHandle::new(NonNull::from(view).cast());
// Optionally set the view controller.
handle.ui_view_controller = None;

Trait Implementations

impl Clone for UiKitWindowHandle

fn clone(&self) -> UiKitWindowHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UiKitWindowHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<UiKitWindowHandle> for RawWindowHandle

fn from(value: UiKitWindowHandle) -> RawWindowHandle

Converts to this type from the input type.

impl Hash for UiKitWindowHandle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UiKitWindowHandle

fn eq(&self, other: &UiKitWindowHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for UiKitWindowHandle

impl Eq for UiKitWindowHandle

impl StructuralPartialEq for UiKitWindowHandle