Struct raw_window_handle::UiKitWindowHandle
source · #[non_exhaustive]pub struct UiKitWindowHandle {
pub ui_view: NonNull<c_void>,
pub ui_view_controller: Option<NonNull<c_void>>,
}
Expand description
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)§
This struct is marked as 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§
Trait Implementations§
source§impl Clone for UiKitWindowHandle
impl Clone for UiKitWindowHandle
source§fn clone(&self) -> UiKitWindowHandle
fn clone(&self) -> UiKitWindowHandle
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for UiKitWindowHandle
impl Debug for UiKitWindowHandle
source§impl From<UiKitWindowHandle> for RawWindowHandle
impl From<UiKitWindowHandle> for RawWindowHandle
source§fn from(value: UiKitWindowHandle) -> Self
fn from(value: UiKitWindowHandle) -> Self
Converts to this type from the input type.
source§impl Hash for UiKitWindowHandle
impl Hash for UiKitWindowHandle
source§impl PartialEq for UiKitWindowHandle
impl PartialEq for UiKitWindowHandle
source§fn eq(&self, other: &UiKitWindowHandle) -> bool
fn eq(&self, other: &UiKitWindowHandle) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl Copy for UiKitWindowHandle
impl Eq for UiKitWindowHandle
impl StructuralPartialEq for UiKitWindowHandle
Auto Trait Implementations§
impl Freeze for UiKitWindowHandle
impl RefUnwindSafe for UiKitWindowHandle
impl !Send for UiKitWindowHandle
impl !Sync for UiKitWindowHandle
impl Unpin for UiKitWindowHandle
impl UnwindSafe for UiKitWindowHandle
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more