Struct AppKitWindowHandle

#[non_exhaustive]
pub struct AppKitWindowHandle {
    pub ns_view: NonNull<c_void>,
}

Raw window handle for AppKit.

Note that NSView 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(target_os = "macos")]
use objc2_app_kit::NSView;
use objc2_foundation::is_main_thread;
use objc2::rc::Id;
use raw_window_handle::{WindowHandle, RawWindowHandle};

let handle: WindowHandle<'_>; // Get the window handle from somewhere else
match handle.as_raw() {
    RawWindowHandle::AppKit(handle) => {
        assert!(is_main_thread(), "can only access AppKit handles on the main thread");
        let ns_view = handle.ns_view.as_ptr();
        // SAFETY: The pointer came from `WindowHandle`, which ensures
        // that the `AppKitWindowHandle` contains a valid pointer to an
        // `NSView`.
        // Unwrap is fine, since the pointer came from `NonNull`.
        let ns_view: Id<NSView> = unsafe { Id::retain(ns_view.cast()) }.unwrap();
        // Do something with the NSView here, like getting the `NSWindow`
        let ns_window = ns_view.window().expect("view was not installed in a window");
    }
    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.

ns_view: NonNull<c_void>

A pointer to an NSView object.

Implementations

impl AppKitWindowHandle

pub fn new(ns_view: NonNull<c_void>) -> Self

Create a new handle to a view.

Example

let view: &NSView;
let handle = AppKitWindowHandle::new(NonNull::from(view).cast());

Trait Implementations

impl Clone for AppKitWindowHandle

fn clone(&self) -> AppKitWindowHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppKitWindowHandle

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

Formats the value using the given formatter.

impl From<AppKitWindowHandle> for RawWindowHandle

fn from(value: AppKitWindowHandle) -> Self

Converts to this type from the input type.

impl Hash for AppKitWindowHandle

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

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 AppKitWindowHandle

fn eq(&self, other: &AppKitWindowHandle) -> 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 AppKitWindowHandle

impl Eq for AppKitWindowHandle

impl StructuralPartialEq for AppKitWindowHandle